Written briefing begin

POST/v1/written-briefings

Signed-in sessionLaunch key product.filesOperation written_briefing_begin

Written and audio briefings from a person's work and memory: schedules, a listening queue, one player that keeps playing across the suite, a private feed and verified email delivery.

Body

sourcesobject[]
titlestring
briefingIdstring
expectedAuthorizationVersionstring
lengthstringRequired
instructionsstringRequired
idempotencyKeystringRequired

Returns

briefingIdstringRequired
revisionIdstringRequired
uploadobjectRequired
requeststringRequired
includedobject[]Required
droppedobject[]Required

Errors

400, 401, 403, 404, 409, 429 and 503 return {"error": {"code", "message", "correlationId"}}.

curl "$SPECIFY_API_ORIGIN/v1/written-briefings" \ -X POST \ -H "Authorization: Bearer $SPECIFY_SESSION_TOKEN" \ -H "X-Specify-Account-Id: <accountId>" \ -H "X-Specify-Service-Tenancy-Id: <serviceTenancyId>" \ -H "Content-Type: application/json" \ -d '{"length":"<length>","instructions":"<instructions>","idempotencyKey":"retry-1"}'

{ "result": { "briefingId": "<briefingId>", "revisionId": "<revisionId>", "upload": { "id": "<id>", "fileId": "<fileId>", "phase": "available", "retryable": true, "expiresAt": 1 }, "request": "<request>", "included": [ { "kind": "<kind>", "id": "<id>", "title": "<title>", "trimmed": true } ], "dropped": [ { "kind": "<kind>", "id": "<id>", "title": "<title>", "reason": "<reason>" } ] } }

Written briefing begin

Headers

Body

Returns

Errors