List Share Links | SpeechifyAI API

{
  "next_cursor": "cursor_01k9x7v4b2m5n8p0q3r4s6t7u8v",
  "has_more": true,
  "share_links": [
    {
      "id": "share_01k9x7v4b2m5n8p0q3r4s6t7u8v",
      "agent_id": "agent_01jqr8x9zg5k2m3n4p5q6r7s8t",
      "label": "Sent to Acme Inc, 2024-04-10",
      "token_prefix": "Ax7Kq2Rd",
      "token_recoverable": true,
      "status": "active",
      "expires_at": "2024-08-10T17:00:00Z",
      "revoked_at": null,
      "budget_seconds": 3600,
      "seconds_used": 1200,
      "seconds_reserved": 300,
      "seconds_remaining": 2100,
      "max_call_duration_seconds": 300,
      "max_concurrent": 3,
      "allowed_tool_ids": [
        "tool_01k9x7v4b2m5n8p0q3r4s6t7u8v"
      ],
      "last_used_at": "2024-04-15T14:45:00Z",
      "created_at": "2024-04-10T09:00:00Z"
    }
  ]
}

List the agent’s share links, most recently created first. Cursor-paginated: omit cursor to fetch the first page.

Revoked and expired links are included — an owner needs to see what they have handed out, not only what is currently live. The bearer token is never returned; only a short masked prefix so two links can be told apart.

Authentication

AuthorizationBearer

Enter your API key with the Bearer prefix, e.g. ‘Bearer sk_…’.

Path parameters

agent_idstringRequired

Agent id (prefixed external id, agent_...).

Query parameters

cursorstringOptional

Opaque pagination cursor from a previous response.

limitintegerOptional1-200Defaults to 50

Max items per page (default 50, max 200).

Response headers

Speechify-Request-IdstringOptional

Unique identifier for this request, present on every response (2xx and non-2xx alike). If the caller sends a Speechify-Request-Id request header the server echoes it back (sanitized and length-capped) so one logical request can be traced end-to-end; otherwise the server generates a fresh value. Log it on every response and quote it in support requests

it is the stable handle that ties your observation to Speechify’s server-side logs, and it matches the request_id field in the error envelope.

The legacy alias X-Request-ID carries the same value and is still accepted on requests, until 2027-07-24. Prefer the un-prefixed name (RFC 6648).

Unique identifier for this request, present on every response (2xx and non-2xx alike). If the caller sends a `Speechify-Request-Id` request header the server echoes it back (sanitized and length-capped) so one logical request can be traced end-to-end; otherwise the server generates a fresh value. Log it on every response and quote it in support requests - it is the stable handle that ties your observation to Speechify's server-side logs, and it matches the `request_id` field in the error envelope. The legacy alias `X-Request-ID` carries the same value and is still accepted on requests, until 2027-07-24. Prefer the un-prefixed name (RFC 6648).

Response

A page of share links.

next_cursorstring or null

Opaque keyset cursor for the next page. Pass back as the cursor request parameter. null when the caller has reached the end of the list (has_more is also false in that case).

has_moreboolean

True when more rows exist beyond this page.

share_linkslist of objects

Errors

401

Unauthorized Error

404

Not Found Error

$	curl https://api.speechify.ai/v1/agents/agent_01jqr8x9zg5k2m3n4p5q6r7s8t/share-links \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json"