Probably
Start free
Docs

Get a video

get_video, in Reads: Any connection or key may call these.

POST
/api/v1/tools/get_video

A video's current brief (its text and objective) and its latest run on its main line, or on the variant line names: its status, its steps, what the crew did (activity summaries), the conversation's newest messages, what is delivered and what waits on you. Pass since (the last cursor) to get only what changed after it.

Authorization

apiKey
headerAuthorizationBearer <token>

An API key (prb_…) from Settings → Connections.

Request Body

application/json
  1. body
videoId*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
line?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
since?string
Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Formatdate-time

Response Body

The tool's answer.

application/json
  1. response
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
name*string
spaceId*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
brief*
run*|null
messages*array<>
deliveries*array<>
cursor*string
curl -X POST 'https://studio.probably.co/api/v1/tools/get_video' \  -H "Authorization: Bearer $PROBABLY_API_KEY" \  -H 'Content-Type: application/json' \  -d '{  "videoId": "3524e86f-1bba-489a-bf6b-386ea1abbac0"}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "spaceId": "a330a273-e64a-4183-aedb-f3152797a9a5",  "brief": {    "revisionId": "bae12d01-48af-47b3-9304-b09ef0081cd6",    "text": "string",    "objective": "reach"  },  "run": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "status": "queued",    "steps": [      {        "stage": "string",        "status": "pending"      }    ],    "activity": [      {        "title": "string",        "status": "working",        "details": [          "string"        ],        "startedAt": "string",        "finishedAt": "string"      }    ],    "pause": {      "kind": "credits",      "message": "string"    },    "charges": {      "priceCredits": 0,      "chargedCredits": 0,      "lines": [        {          "line": "script",          "credits": 0        }      ],      "rounds": [        {          "line": "script",          "credits": 0,          "stage": "string"        }      ]    },    "slot": {      "reason": "organization",      "place": 1    },    "waitingOnYou": [      {        "kind": "delivery-approval",        "message": "string",        "runId": "78c33d18-170c-44d3-a227-b3194f134f73",        "versionId": "14707576-2549-4848-82ed-f68f8a1b47c7"      }    ]  },  "messages": [    {      "id": "string",      "role": "system",      "text": "string",      "final": true,      "changedAt": "string"    }  ],  "deliveries": [    {      "runId": "78c33d18-170c-44d3-a227-b3194f134f73",      "versionId": "14707576-2549-4848-82ed-f68f8a1b47c7",      "format": "string",      "deliveredAt": "string"    }  ],  "cursor": "string"}