GET
/
v1
/
teams
/
{teamId}
/
personas
/
{personaId}
/
media
TypeScript client
import { OctosparkClient } from '@octospark/sdk'

const client = new OctosparkClient({
  token: process.env.OCTOSPARK_TOKEN
})

const response = await client.personas.listPersonaMedia({
  teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
  personaId: process.env.OCTOSPARK_PERSONA_ID ?? "personaId",
  query: {},
})
{
  "data": [
    {
      "personaId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "assetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "generationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "portrayedAge": 123,
      "isReference": true,
      "isPrimary": true,
      "sortOrder": 123,
      "promotedAt": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "total": 123,
  "nextCursor": "<string>",
  "prevCursor": "<string>",
  "pageOffset": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
teamId
string
required

Team (workspace) id (UUID). Discover ids via the list teams endpoint or the agent context.

​
personaId
string
required

Persona id (UUID), returned by list or create persona.

Query Parameters

​
cursor
string

Cursor returned by a previous persona media response.

​
limit
string

a string to be decoded into a number

Response

Success

​
data
object[]
required
​
total
number
required
​
nextCursor
string | null
required

Opaque cursor for the page after this one; null on the last page.

​
prevCursor
string | null
required

Opaque cursor for the page before this one; null on the first page. Lists on the signed cursor standard return a real backwards cursor; older lists echo the request cursor.

​
pageOffset
number | null

Zero-based position of the first row of this page within total (for "Showing 26-50 of 268" and page numbers); null when unknown.