OCT-103 Gumlet outreach
POST/video/sources/live

Create a live stream workspace

Creates a live stream workspace. Supply its name in the request body to identify the collection. The response includes the created workspace's ID and timestamps.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 body field

Live stream workspace details. The name field is required.

namestringrequired

Collection name

5 status codes
200Returns the created live stream workspace, including its ID, name, creation timestamp, update timestamp, and associated video workspace ID when available.
created_atstringrequired

Creation timestamp in ISO 8601 format

idstringrequired

LIve stream workspace ID

namestringrequired

Name of the live stream workspace

updated_atstringrequired

Update timestamp in ISO 8601 format

video_workspace_idstringoptional

Video workspace ID attached to this collection.

400Returned when the request is invalid.

One documented failure

  • parameter_missingname

    One or more required values are missing.

errorobjectrequired
401Returned when the request omits or supplies an invalid API key or bearer token.

One documented failure

  • invalid_api_key

    API key supplied with request is invalid

errorobjectrequired
403Returned when the live source limit is reached on a free or starter plan.
errorstringrequired
422Returned when request validation fails.

One documented failure

  • invalid_parameter

    body must have required property '<field>'

errorobjectrequired

Error handling

A 400 is returned when the request is invalid. A 401 is returned when the request omits or supplies an invalid API key or bearer token. A 403 is returned when the live source limit is reached on a free or starter plan, and a 422 is returned when request validation fails. The body must include name.