Get a document

GET/v1/videos/{id}/docs/{kind}

Authorization

bearerAuth

AuthorizationBearer <token>

API token issued from the dashboard (Settings → API Tokens). Sent as Authorization: Bearer <token>.

In: header

Path Parameters

id*string

Match

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Formatuuid

kind*string

Response Body

`application/json`

cURL

curl -X GET "https://example.com/videos/497f6eca-6276-4993-bfeb-53cbbbba6f08/docs/research"

{
  "success": true,
  "doc": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "videoId": "3524e86f-1bba-489a-bf6b-386ea1abbac0",
    "kind": "research",
    "title": "string",
    "content": "string",
    "sortOrder": -9007199254740991,
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "error": "validation_failed",
  "message": "string",
  "issues": null
}

{
  "error": "unauthorized"
}

{
  "error": "validation_failed",
  "message": "string",
  "issues": null
}

Authorization

Path Parameters

Response Body

200application/json

400application/json

401application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`