v1

latestOpenAPI 3.0.02026-07-1761823.7 KB

Stream object

Stream object generation for a specific workflow (we strongly recommend using the SDK for this)

post/api/v1/stream/object

Request body

inputstring required

The input text to generate a response for

workflowSlugstring required

The slug of the Workflow to use for generation (can be found in the Itzam dashboard)

groupIdstring

Optional identifier for grouping related runs (e.g. user ID, session ID, etc.)

schemaobject

The schema of the response, JSON Schema

Example request

{
  "input": "Tell me about renewable energy",
  "workflowSlug": "my_great_workflow",
  "groupId": "my-group-id",
  "schema": {
    "title": "My great response",
    "description": "The response to the input",
    "type": "object"
  }
}

Response

Successfully streaming content