POST
/
v1
/
observe
/
workflows

WorkflowStep

A workflow step is the atomic unit of logging to Galileo. They represent a single execution of a workflow, such as a chain, agent, or a RAG execution. Workflows can have multiple steps, each of which can be a different type of node, such as an LLM, Retriever, or Tool.

You can log multiple workflows in a single request. Each workflow step must have the following fields:

  • type: The type of the workflow.
  • input: The input to the workflow.
  • output: The output of the workflow.

Examples

LLM Step

{
  "type": "llm",
  "input": "What is the capital of France?",
  "output": "Paris"
}

Retriever Step

{
  "type": "retriever",
  "input": "What is the capital of France?",
  "output": [{ "content": "Paris is the capital and largest city of France." }]
}

Multi-Step

Workflow steps of type workflow, agent or chain can have sub-steps with children. A workflow with a retriver and an LLM step would look like this:

{
  "type": "workflow",
  "input": "What is the capital of France?",
  "output": "Paris",
  "steps": [
    {
      "type": "retriever",
      "input": "What is the capital of France?",
      "output": [{ "content": "Paris is the capital and largest city of France." }]
    },
    {
      "type": "llm",
      "input": "What is the capital of France?",
      "output": "Paris"
    }
  ]
}

Authorizations

Galileo-API-Key
string
headerrequired

Query Parameters

scope
string | null
default:

Body

application/json
workflows
object[]
required

List of workflows to log.

project_id
string | null

Project ID for the Observe project.

project_name
string | null

Project name for the Observe project.

Response

200 - application/json
message
string
required
project_id
string
required
project_name
string
required
workflows_count
integer
required
records_count
integer
required