Get Workflows

POST

observe

projects

{project_id}

workflows

curl --request POST \
  --url https://api.acme.rungalileo.io/v1/observe/projects/{project_id}/workflows \
  --header 'Content-Type: application/json' \
  --header 'Galileo-API-Key: <api-key>' \
  --data '{
  "starting_token": 0,
  "limit": 100,
  "filters": [
    {
      "name": "user_metadata",
      "operator": "one_of",
      "key": "<string>",
      "value": "<string>"
    }
  ]
}'

{
  "starting_token": 0,
  "limit": 100,
  "paginated": false,
  "next_starting_token": 123,
  "workflows": [
    {
      "type": "workflow",
      "input": "<string>",
      "output": "<string>",
      "name": "",
      "created_at_ns": 123,
      "duration_ns": 0,
      "metadata": {},
      "status_code": 123,
      "ground_truth": "<string>",
      "root_workflow_id": "<string>",
      "workflow_id": "<string>",
      "step_id": "<string>",
      "steps": [
        {}
      ],
      "metrics": [
        {
          "name": "<string>",
          "value": "<any>"
        }
      ]
    }
  ]
}

Authorizations

Galileo-API-Key

string

header

required

Path Parameters

project_id

string

required

Query Parameters

start_time

string | null

end_time

string | null

Body

application/json

starting_token

integer

default:

limit

integer

default:

100

filters

object[]

Response

200

application/json

Successful Response

Response model for workflow evaluation results

workflows

object[]

required

workflows.input

string

required

Input to the step.

workflows.type

enum<string>

Type of the step. By default, it is set to workflow.

Available options:

chain,

chat,

llm,

retriever,

tool,

agent,

workflow,

trace

workflows.output

string

Output of the step.

workflows.name

string

default:

Name of the step.

workflows.created_at_ns

integer

Timestamp of the step's creation, as nanoseconds since epoch.

workflows.duration_ns

integer

default:

Duration of the step in nanoseconds.

workflows.metadata

object

Metadata associated with this step.

workflows.status_code

integer | null

Status code of the step. Used for logging failed/errored steps.

workflows.ground_truth

string | null

Ground truth expected output for the step.

workflows.root_workflow_id

string | null

workflows.workflow_id

string | null

workflows.step_id

string | null

workflows.steps

object[] | null

workflows.steps.input

string

required

Input to the step.

workflows.steps.type

enum<string>

Type of the step. By default, it is set to workflow.

Available options:

chain,

chat,

llm,

retriever,

tool,

agent,

workflow,

trace

workflows.steps.output

string

Output of the step.

workflows.steps.name

string

default:

Name of the step.

workflows.steps.created_at_ns

integer

Timestamp of the step's creation, as nanoseconds since epoch.

workflows.steps.duration_ns

integer

default:

Duration of the step in nanoseconds.

workflows.steps.metadata

object

Metadata associated with this step.

workflows.steps.status_code

integer | null

Status code of the step. Used for logging failed/errored steps.

workflows.steps.ground_truth

string | null

Ground truth expected output for the step.

workflows.steps.root_workflow_id

string | null

workflows.steps.workflow_id

string | null

workflows.steps.step_id

string | null

workflows.steps.steps

object[] | null

workflows.steps.steps.input

string

required

Input to the step.

workflows.steps.steps.type

enum<string>

Type of the step. By default, it is set to workflow.

Available options:

chain,

chat,

llm,

retriever,

tool,

agent,

workflow,

trace

workflows.steps.steps.output

string

Output of the step.

workflows.steps.steps.name

string

default:

Name of the step.

workflows.steps.steps.created_at_ns

integer

Timestamp of the step's creation, as nanoseconds since epoch.

workflows.steps.steps.duration_ns

integer

default:

Duration of the step in nanoseconds.

workflows.steps.steps.metadata

object

Metadata associated with this step.

workflows.steps.steps.status_code

integer | null

Status code of the step. Used for logging failed/errored steps.

workflows.steps.steps.ground_truth

string | null

Ground truth expected output for the step.

workflows.steps.steps.root_workflow_id

string | null

workflows.steps.steps.workflow_id

string | null

workflows.steps.steps.step_id

string | null

workflows.steps.steps.steps

object[] | null

workflows.steps.steps.metrics

object[] | null

workflows.steps.metrics

object[] | null

workflows.metrics

object[] | null

starting_token

integer

default:

limit

integer

default:

100

paginated

boolean

default:

false

next_starting_token

integer | null

Was this page helpful?

Suggest edits Raise issue

Log Workflows to an Observe Project Invoke Protect

curl --request POST \
  --url https://api.acme.rungalileo.io/v1/observe/projects/{project_id}/workflows \
  --header 'Content-Type: application/json' \
  --header 'Galileo-API-Key: <api-key>' \
  --data '{
  "starting_token": 0,
  "limit": 100,
  "filters": [
    {
      "name": "user_metadata",
      "operator": "one_of",
      "key": "<string>",
      "value": "<string>"
    }
  ]
}'

{
  "starting_token": 0,
  "limit": 100,
  "paginated": false,
  "next_starting_token": 123,
  "workflows": [
    {
      "type": "workflow",
      "input": "<string>",
      "output": "<string>",
      "name": "",
      "created_at_ns": 123,
      "duration_ns": 0,
      "metadata": {},
      "status_code": 123,
      "ground_truth": "<string>",
      "root_workflow_id": "<string>",
      "workflow_id": "<string>",
      "step_id": "<string>",
      "steps": [
        {}
      ],
      "metrics": [
        {
          "name": "<string>",
          "value": "<any>"
        }
      ]
    }
  ]
}

API Reference

health

auth

evaluate

observe

protect

Authorizations

Path Parameters

Query Parameters

Body

Response