API REFERENCE

Get Chat Artist

On this page

GET/api/chats/{id}/artist

Retrieve the artist associated with a specific chat room. Returns 404 if the chat does not exist or is not accessible by the authenticated caller.

Authentication

See the authentication guide for API key and account access requirements.

Request

cURL

curl --request GET \
  --url 'https://api.recoupable.dev/api/chats/YOUR_ID/artist' \
  --header 'x-api-key: YOUR_API_KEY'

Replace the YOUR_ placeholders with your values. Required query parameters are included; optional parameters are listed below.

Parameters

Path parameters

idstringrequired

The unique identifier (UUID) of the chat room.

Responses

200Chat artist resolved successfully

application/json

statusstring · enumrequired

Status of the request

Values: "success"

room_idstringrequired

UUID of the chat room

format: uuid

artist_idstringrequirednullable

UUID of the artist account associated with the chat, or null when no artist is linked

format: uuid

artist_existsbooleanrequired

Whether an artist is linked to the chat room

400Bad request - invalid chat id

application/json

statusstring · enumrequired

Status of the request

Values: "error"

errorstringrequired

Error message describing what went wrong

401Unauthorized - invalid or missing credentials

application/json

errorintegerrequired

format: int32

messagestringrequired

404Not found - chat does not exist or is not accessible

application/json

statusstring · enumrequired

Status of the request

Values: "error"

errorstringrequired

Error message describing what went wrong

Full specification

Download the OpenAPI file for complete schemas, constraints, and examples.

Download research.json

View operation source

json

{
  "description": "Retrieve the artist associated with a specific chat room. Returns 404 if the chat does not exist or is not accessible by the authenticated caller.",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "The unique identifier (UUID) of the chat room.",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Chat artist resolved successfully",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/GetChatArtistResponse"
          }
        }
      }
    },
    "400": {
      "description": "Bad request - invalid chat id",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/GetChatArtistErrorResponse"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized - invalid or missing credentials",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    },
    "404": {
      "description": "Not found - chat does not exist or is not accessible",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/GetChatArtistErrorResponse"
          }
        }
      }
    }
  }
}