Agents and workflows

AI agents, workflows and their runs.

Base URL: https://api.fjordrun.com. Generated from the OpenAPI document (API version 0.1.0).

List AI models

GET /api/v1/models

Authentication: none.

Response

200: JSON.

Example

bash

curl "https://api.fjordrun.com/api/v1/models"

List agents

GET /api/v1/teams/{tid}/agents

Authentication: a team API token or personal access token.

Parameters

Name	In	Type	Required	Description
`tid`	path	string (UUID)	yes

Response

200: JSON.

Example

bash

curl "https://api.fjordrun.com/api/v1/teams/$TEAM_ID/agents" \
  -H "Authorization: Bearer $FJORDRUN_TOKEN"

Create agent

POST /api/v1/teams/{tid}/agents

Authentication: a team API token or personal access token.

Parameters

Name	In	Type	Required	Description
`tid`	path	string (UUID)	yes

Request body

Field	Type	Required	Description
`name`	string	yes	min length 1, max length 100
`description`	string	no	max length 2000, can be `null`
`project_id`	string (UUID)	no	can be `null`
`model`	string	no	default `"claude-opus-5-5"`
`system_prompt`	string	no	max length 100000, default `"You are a helpful agent."`
`tools`	array of string	no
`max_steps`	integer	no	min 1, max 100, default `10`
`temperature`	number	no	min 0, max 1, default `1`

Response

201: JSON.

Example

bash

curl -X POST "https://api.fjordrun.com/api/v1/teams/$TEAM_ID/agents" \
  -H "Authorization: Bearer $FJORDRUN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"string"}'

Get agent

GET /api/v1/agents/{aid}

Authentication: a team API token or personal access token.

Parameters

Name	In	Type	Required	Description
`aid`	path	string (UUID)	yes

Response

200: JSON.

Example

bash

curl "https://api.fjordrun.com/api/v1/agents/$AGENT_ID" \
  -H "Authorization: Bearer $FJORDRUN_TOKEN"

Update agent

PATCH /api/v1/agents/{aid}

Authentication: a team API token or personal access token.

Parameters

Name	In	Type	Required	Description
`aid`	path	string (UUID)	yes

Request body

Field	Type	Required	Description
`name`	string	no	min length 1, max length 100, can be `null`
`description`	string	no	max length 2000, can be `null`
`project_id`	string (UUID)	no	can be `null`
`model`	string	no	can be `null`
`system_prompt`	string	no	max length 100000, can be `null`
`tools`	array of string	no	can be `null`
`max_steps`	integer	no	min 1, max 100, can be `null`
`temperature`	number	no	min 0, max 1, can be `null`

Response

200: JSON.

Example

bash

curl -X PATCH "https://api.fjordrun.com/api/v1/agents/$AGENT_ID" \
  -H "Authorization: Bearer $FJORDRUN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"string"}'

Delete agent

DELETE /api/v1/agents/{aid}

Authentication: a team API token or personal access token.

Parameters

Name	In	Type	Required	Description
`aid`	path	string (UUID)	yes

Response

204: no content.

Example

bash

curl -X DELETE "https://api.fjordrun.com/api/v1/agents/$AGENT_ID" \
  -H "Authorization: Bearer $FJORDRUN_TOKEN"

Chat with an agent

POST /api/v1/agents/{aid}/chat

Authentication: a team API token or personal access token.

Parameters

Name	In	Type	Required	Description
`aid`	path	string (UUID)	yes

Request body

Field	Type	Required	Description
`messages`	array of ChatMessage	yes	min 1 items, max 200 items

Response

200: JSON.

Example

bash

curl -X POST "https://api.fjordrun.com/api/v1/agents/$AGENT_ID/chat" \
  -H "Authorization: Bearer $FJORDRUN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"messages":[{"role":"user","content":"string"}]}'

List workflows

GET /api/v1/teams/{tid}/workflows

Authentication: a team API token or personal access token.

Parameters

Name	In	Type	Required	Description
`tid`	path	string (UUID)	yes

Response

200: JSON.

Example

bash

curl "https://api.fjordrun.com/api/v1/teams/$TEAM_ID/workflows" \
  -H "Authorization: Bearer $FJORDRUN_TOKEN"

Create workflow

POST /api/v1/teams/{tid}/workflows

Authentication: a team API token or personal access token.

Parameters

Name	In	Type	Required	Description
`tid`	path	string (UUID)	yes

Request body

Field	Type	Required	Description
`name`	string	yes	min length 1, max length 150
`description`	string	no	max length 2000, can be `null`
`project_id`	string (UUID)	no	can be `null`
`definition`	object	no	can be `null`
`triggers`	array of TriggerIn	no	can be `null`

Response

201: JSON.

Example

bash

curl -X POST "https://api.fjordrun.com/api/v1/teams/$TEAM_ID/workflows" \
  -H "Authorization: Bearer $FJORDRUN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"string"}'

Get workflow

GET /api/v1/workflows/{wid}

Authentication: a team API token or personal access token.

Parameters

Name	In	Type	Required	Description
`wid`	path	string (UUID)	yes

Response

200: JSON.

Example

bash

curl "https://api.fjordrun.com/api/v1/workflows/$WORKFLOW_ID" \
  -H "Authorization: Bearer $FJORDRUN_TOKEN"

Update workflow

PATCH /api/v1/workflows/{wid}

Authentication: a team API token or personal access token.

Parameters

Name	In	Type	Required	Description
`wid`	path	string (UUID)	yes

Request body

Field	Type	Required	Description
`name`	string	no	min length 1, max length 150, can be `null`
`description`	string	no	max length 2000, can be `null`
`project_id`	string (UUID)	no	can be `null`
`definition`	object	no	can be `null`
`triggers`	array of TriggerIn	no	can be `null`
`is_active`	boolean	no	can be `null`

Response

200: JSON.

Example

bash

curl -X PATCH "https://api.fjordrun.com/api/v1/workflows/$WORKFLOW_ID" \
  -H "Authorization: Bearer $FJORDRUN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"string"}'

Delete workflow

DELETE /api/v1/workflows/{wid}

Authentication: a team API token or personal access token.

Parameters

Name	In	Type	Required	Description
`wid`	path	string (UUID)	yes

Response

204: no content.

Example

bash

curl -X DELETE "https://api.fjordrun.com/api/v1/workflows/$WORKFLOW_ID" \
  -H "Authorization: Bearer $FJORDRUN_TOKEN"

Run a workflow

POST /api/v1/workflows/{wid}/runs

Authentication: a team API token or personal access token.

Parameters

Name	In	Type	Required	Description
`wid`	path	string (UUID)	yes

Request body

An empty object.

Response

201: JSON.

Example

bash

curl -X POST "https://api.fjordrun.com/api/v1/workflows/$WORKFLOW_ID/runs" \
  -H "Authorization: Bearer $FJORDRUN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

List runs

GET /api/v1/workflows/{wid}/runs

Authentication: a team API token or personal access token.

Parameters

Name	In	Type	Required	Description
`wid`	path	string (UUID)	yes
`limit`	query	integer	no	min 1, max 200, default `30`

Response

200: JSON.

Example

bash

curl "https://api.fjordrun.com/api/v1/workflows/$WORKFLOW_ID/runs" \
  -H "Authorization: Bearer $FJORDRUN_TOKEN"

Get run

GET /api/v1/runs/{rid}

Authentication: a team API token or personal access token.

Parameters

Name	In	Type	Required	Description
`rid`	path	string (UUID)	yes

Response

200: JSON.

Example

bash

curl "https://api.fjordrun.com/api/v1/runs/$RUN_ID" \
  -H "Authorization: Bearer $FJORDRUN_TOKEN"

Cancel run

POST /api/v1/runs/{rid}/cancel

Authentication: a team API token or personal access token.

Parameters

Name	In	Type	Required	Description
`rid`	path	string (UUID)	yes

Response

200: JSON.

Example

bash

curl -X POST "https://api.fjordrun.com/api/v1/runs/$RUN_ID/cancel" \
  -H "Authorization: Bearer $FJORDRUN_TOKEN"

Approve run

POST /api/v1/runs/{rid}/approve

Authentication: a team API token or personal access token.

Parameters

Name	In	Type	Required	Description
`rid`	path	string (UUID)	yes

Request body

Field	Type	Required	Description
`node_id`	string	yes
`approved`	boolean	yes
`comment`	string	no	max length 2000, can be `null`

Response

200: JSON.

Example

bash

curl -X POST "https://api.fjordrun.com/api/v1/runs/$RUN_ID/approve" \
  -H "Authorization: Bearer $FJORDRUN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"node_id":"string","approved":true}'

Stream a run

GET /api/v1/runs/{rid}/stream

Authentication: a team API token or personal access token.

Response: a stream of Server-Sent Events. Browsers cannot set headers on an EventSource, so the token may also be passed as the token query parameter.

Parameters

Name	In	Type	Required	Description
`rid`	path	string (UUID)	yes
`token`	query	string	no	can be `null`

Response

200: JSON.

Example

bash

curl "https://api.fjordrun.com/api/v1/runs/$RUN_ID/stream" \
  -H "Authorization: Bearer $FJORDRUN_TOKEN"

Trigger a workflow by webhook

POST /api/v1/hooks/workflows/{wid}/{secret}

Authentication: none.

Parameters

Name	In	Type	Required	Description
`wid`	path	string (UUID)	yes
`secret`	path	string	yes

Response

200: JSON.

Example

bash

curl -X POST "https://api.fjordrun.com/api/v1/hooks/workflows/$WORKFLOW_ID/$SECRET"

Request objects

AgentIn

Field	Type	Required	Description
`name`	string	yes	min length 1, max length 100
`description`	string	no	max length 2000, can be `null`
`project_id`	string (UUID)	no	can be `null`
`model`	string	no	default `"claude-opus-5-5"`
`system_prompt`	string	no	max length 100000, default `"You are a helpful agent."`
`tools`	array of string	no
`max_steps`	integer	no	min 1, max 100, default `10`
`temperature`	number	no	min 0, max 1, default `1`

AgentPatch

Field	Type	Required	Description
`name`	string	no	min length 1, max length 100, can be `null`
`description`	string	no	max length 2000, can be `null`
`project_id`	string (UUID)	no	can be `null`
`model`	string	no	can be `null`
`system_prompt`	string	no	max length 100000, can be `null`
`tools`	array of string	no	can be `null`
`max_steps`	integer	no	min 1, max 100, can be `null`
`temperature`	number	no	min 0, max 1, can be `null`

ApproveIn

Field	Type	Required	Description
`node_id`	string	yes
`approved`	boolean	yes
`comment`	string	no	max length 2000, can be `null`

ChatIn

Field	Type	Required	Description
`messages`	array of ChatMessage	yes	min 1 items, max 200 items

ChatMessage

Field	Type	Required	Description
`role`	`"user"`, `"assistant"`	yes
`content`	string	yes	max length 200000

TriggerIn

Field	Type	Required	Description
`type`	`"manual"`, `"cron"`, `"webhook"`, `"api"`	yes
`cron`	string	no	can be `null`

WorkflowIn

Field	Type	Required	Description
`name`	string	yes	min length 1, max length 150
`description`	string	no	max length 2000, can be `null`
`project_id`	string (UUID)	no	can be `null`
`definition`	object	no	can be `null`
`triggers`	array of TriggerIn	no	can be `null`

WorkflowPatch

Field	Type	Required	Description
`name`	string	no	min length 1, max length 150, can be `null`
`description`	string	no	max length 2000, can be `null`
`project_id`	string (UUID)	no	can be `null`
`definition`	object	no	can be `null`
`triggers`	array of TriggerIn	no	can be `null`
`is_active`	boolean	no	can be `null`

Agents and workflows ​

List AI models ​

List agents ​

Create agent ​

Get agent ​

Update agent ​

Delete agent ​

Chat with an agent ​

List workflows ​

Create workflow ​

Get workflow ​

Update workflow ​

Delete workflow ​

Run a workflow ​

List runs ​

Get run ​

Cancel run ​

Approve run ​

Stream a run ​

Trigger a workflow by webhook ​

Request objects ​

AgentIn ​

AgentPatch ​

ApproveIn ​

ChatIn ​

ChatMessage ​

TriggerIn ​

WorkflowIn ​

WorkflowPatch ​

Agents and workflows

List AI models

List agents

Create agent

Get agent

Update agent

Delete agent

Chat with an agent

List workflows

Create workflow

Get workflow

Update workflow

Delete workflow

Run a workflow

List runs

Get run

Cancel run

Approve run

Stream a run

Trigger a workflow by webhook

Request objects

AgentIn

AgentPatch

ApproveIn

ChatIn

ChatMessage

TriggerIn

WorkflowIn

WorkflowPatch