Get Workflow Details

curl --request GET \
  --url https://api.example.com/workflows/{workflow_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/workflows/{workflow_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/workflows/{workflow_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/workflows/{workflow_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/workflows/{workflow_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "content-creation-workflow",
  "name": "Content Creation Workflow",
  "description": "Automated content creation from blog posts to social media",
  "db_id": "123"
}

{
  "detail": "Bad request"
}

{
  "detail": "Unauthenticated access"
}

{
  "detail": "Not found"
}

{
  "detail": [
    {
      "loc": [
        "body",
        "endpoint"
      ],
      "msg": "Value error, Endpoint must be a path, not a full URL",
      "type": "value_error"
    }
  ]
}

{
  "detail": "Internal server error"
}

GET

workflows

{workflow_id}

Get Workflow Details

curl --request GET \
  --url https://api.example.com/workflows/{workflow_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/workflows/{workflow_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/workflows/{workflow_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/workflows/{workflow_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/workflows/{workflow_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "content-creation-workflow",
  "name": "Content Creation Workflow",
  "description": "Automated content creation from blog posts to social media",
  "db_id": "123"
}

{
  "detail": "Bad request"
}

{
  "detail": "Unauthenticated access"
}

{
  "detail": "Not found"
}

{
  "detail": [
    {
      "loc": [
        "body",
        "endpoint"
      ],
      "msg": "Value error, Endpoint must be a path, not a full URL",
      "type": "value_error"
    }
  ]
}

{
  "detail": "Internal server error"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workflow_id

string

required

Query Parameters

version

integer | null

Workflow version to retrieve

Response

Workflow details retrieved successfully

string | null

Unique identifier for the workflow

name

string | null

Name of the workflow

db_id

string | null

Database identifier

description

string | null

Description of the workflow

input_schema

Input Schema · object | null

Input schema for the workflow

steps

Steps · object[] | null

List of workflow steps

agent

AgentResponse · object | null

Agent configuration if used

Show child attributes

team

TeamResponse · object | null

Team configuration if used

Show child attributes

metadata

Metadata · object | null

Additional metadata

workflow_agent

boolean

default:false

Whether this workflow uses a WorkflowAgent

is_factory

boolean

default:false

Whether this workflow is a factory

factory_input_schema

Factory Input Schema · object | null

JSON Schema for factory_input

is_component

boolean

default:false

Whether this workflow was created via Builder

current_version

integer | null

Current published version number

stage

string | null

Stage of the loaded config (draft/published)

Agno SDK Reference

AgentOS API Reference

Agno CLI

Agno Infra CLI

Get Workflow Details

Authorizations

Path Parameters

Query Parameters

Response