Skip to content

revert: artist detail endpoint reference #117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
arpitgupta1214 merged 1 commit into from
Apr 9, 2026
+2 −164
Merged

revert: artist detail endpoint reference #117

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions api-reference/artists/get.mdx
View file
Open in desktop

This file was deleted.

161 changes: 2 additions & 159 deletions api-reference/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -573,61 +573,6 @@
}
}
},
"/api/artists/{id}": {
"get": {
"description": "Retrieve a single artist detail payload by artist account ID. Returns the merged artist profile used by the chat product, including profile fields and linked social accounts. Requires authentication via x-api-key or Authorization Bearer token, and the caller must be allowed to access the requested artist account.",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The unique identifier of the artist account to retrieve",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Artist retrieved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetArtistResponse"
}
}
}
},
"400": {
"description": "Bad request - invalid artist id",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArtistsErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized - missing or invalid authentication"
},
"403": {
"description": "Forbidden - the requested artist is not accessible with the provided credentials"
},
"404": {
"description": "Artist not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StatusErrorResponse"
}
}
}
}
}
}
},
"/api/artist/segments": {
"get": {
"description": "Retrieve all segments associated with an artist. This endpoint should be called before using the Segment Fans endpoint to obtain the necessary segment IDs. Supports pagination.",
Expand Down Expand Up @@ -7948,22 +7893,11 @@
}
}
},
"GetArtistResponse": {
"type": "object",
"required": [
"artist"
],
"properties": {
"artist": {
"$ref": "#/components/schemas/ArtistDetail"
}
}
},
"ArtistsErrorResponse": {
"type": "object",
"required": [
"status",
"error"
"message"
],
"properties": {
"status": {
Expand All @@ -7973,14 +7907,7 @@
],
"description": "Status of the request"
},
"missing_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of missing or invalid field names when validation fails"
},
"error": {
"message": {
"type": "string",
"description": "Error message describing what went wrong"
}
Expand Down Expand Up @@ -8111,90 +8038,6 @@
}
}
},
"ArtistDetail": {
"type": "object",
"required": [
"id",
"account_id",
"name",
"account_socials"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "UUID of the artist account"
},
"account_id": {
"type": "string",
"format": "uuid",
"description": "UUID of the artist account (same as id)"
},
"name": {
"type": "string",
"description": "Name of the artist"
},
"image": {
"type": "string",
"nullable": true,
"description": "Artist profile image URL"
},
"instruction": {
"type": "string",
"nullable": true,
"description": "Custom AI instruction or bio for this artist"
},
"knowledges": {
"type": "array",
"nullable": true,
"items": {
"$ref": "#/components/schemas/Knowledge"
},
"description": "Knowledge base files attached to this artist"
},
"label": {
"type": "string",
"nullable": true,
"description": "Record label name"
},
"account_socials": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ArtistAccountSocial"
},
"description": "Linked social accounts formatted for artist settings and chat flows"
}
}
},
"ArtistAccountSocial": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"nullable": true,
"description": "UUID of the linked social profile"
},
"profile_url": {
"type": "string",
"nullable": true,
"description": "Canonical social profile URL"
},
"username": {
"type": "string",
"nullable": true,
"description": "Username or handle for the social profile"
},
"link": {
"type": "string",
"description": "Normalized profile URL used by the chat client"
},
"type": {
"type": "string",
"description": "Derived platform type such as INSTAGRAM, TIKTOK, or SPOTIFY"
}
}
},
"CreateArtistError": {
"type": "object",
"properties": {
Expand Down
1 change: 0 additions & 1 deletion docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,6 @@
"group": "Artists",
"pages": [
"api-reference/artists/list",
"api-reference/artists/get",
"api-reference/artists/create",
"api-reference/artist/segments",
"api-reference/artist/socials",
Expand Down