Context Data
  • Welcome to the Context Data Documentation
  • Quickstart
  • Adding Source Connections
  • Adding Embedding Models
  • Adding Target Connections
  • Create Transformations
  • Create and Run Flows
  • API reference
    • Auth
    • Workspace
      • Source connections
      • Embedding models
      • Chat models
      • Target connections
      • Flows
      • Vector Store Query
      • Query sessions
  • API Documentation (Redoc)
Powered by GitBook
On this page
  1. API reference
  2. Workspace

Flows

PreviousTarget connectionsNextVector Store Query

Last updated 10 months ago

Get Flows

get

Get all Flows created within this account

Authorizations
Responses
get
GET /api/workspace/flows HTTP/1.1
Host: sapphire.contextdata.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

No content

Get Flow

get

Retrieve details of a Flow

Authorizations
Path parameters
flow_identifierstringRequired
Responses
get
GET /api/workspace/flow/{flow_identifier} HTTP/1.1
Host: sapphire.contextdata.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

No content
  • GETGet Flows
  • GETGet Flow
  • POSTTrigger Flow
  • GETGet Flow Logs

Trigger Flow

post

Trigger a flow externally

Authorizations
Path parameters
flow_identifierstringRequired
Responses
application/json
objectOptional
application/json
post

Get Flow Logs

get

Get Flow Logs for a specific flow

Authorizations
Path parameters
flow_identifierstringRequired
Responses
get
200

OK

No content
POST /api/workspace/trigger_flow/{flow_identifier} HTTP/1.1
Host: sapphire.contextdata.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "message": "text",
  "data": {}
}
GET /api/workspace/flow_log/{flow_identifier} HTTP/1.1
Host: sapphire.contextdata.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*