Get an agentic workflow

curl --request GET \
  --url https://api.qovery.com/agenticWorkflow/{agenticWorkflowId} \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.qovery.com/agenticWorkflow/{agenticWorkflowId}', 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.qovery.com/agenticWorkflow/{agenticWorkflowId}",
  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.qovery.com/agenticWorkflow/{agenticWorkflowId}"

	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.qovery.com/agenticWorkflow/{agenticWorkflowId}")

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": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "environment": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "name": "<string>",
  "slug": "<string>",
  "description": "<string>",
  "webhook_ip_allowlist": [
    "<string>"
  ],
  "docker_fragment": "<string>",
  "enabled": true,
  "mcp": "<string>",
  "outputs": [
    {
      "name": "<string>",
      "url": "<string>",
      "headers": [],
      "instructions": ""
    }
  ],
  "model": {
    "settings": "<string>"
  },
  "project_repositories": [
    {
      "url": "<string>",
      "branch": "<string>",
      "git_token_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "agent_prompt": "<string>",
  "governance": {
    "host_allowlist": []
  },
  "resources": {
    "cpu_milli": 1000,
    "ram_mib": 1024,
    "gpu": 0,
    "storage_gib": 0
  },
  "webhook": {
    "url": "<string>"
  },
  "updated_at": "2023-11-07T05:31:56Z",
  "icon_uri": "<string>"
}

GET

agenticWorkflow

{agenticWorkflowId}

Get an agentic workflow

curl --request GET \
  --url https://api.qovery.com/agenticWorkflow/{agenticWorkflowId} \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.qovery.com/agenticWorkflow/{agenticWorkflowId}', 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.qovery.com/agenticWorkflow/{agenticWorkflowId}",
  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.qovery.com/agenticWorkflow/{agenticWorkflowId}"

	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.qovery.com/agenticWorkflow/{agenticWorkflowId}")

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": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "environment": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "name": "<string>",
  "slug": "<string>",
  "description": "<string>",
  "webhook_ip_allowlist": [
    "<string>"
  ],
  "docker_fragment": "<string>",
  "enabled": true,
  "mcp": "<string>",
  "outputs": [
    {
      "name": "<string>",
      "url": "<string>",
      "headers": [],
      "instructions": ""
    }
  ],
  "model": {
    "settings": "<string>"
  },
  "project_repositories": [
    {
      "url": "<string>",
      "branch": "<string>",
      "git_token_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "agent_prompt": "<string>",
  "governance": {
    "host_allowlist": []
  },
  "resources": {
    "cpu_milli": 1000,
    "ram_mib": 1024,
    "gpu": 0,
    "storage_gib": 0
  },
  "webhook": {
    "url": "<string>"
  },
  "updated_at": "2023-11-07T05:31:56Z",
  "icon_uri": "<string>"
}

Authorizations

Authorization

string

header

required

JWT tokens should be used with OIDC account (human to machine). JWT tokens used by the Qovery console to communicate with the API have a TTL. Curl Example ' curl https://console.qovery.com/organization -H "Authorization: Bearer $qovery_token" '

Path Parameters

agenticWorkflowId

string<uuid>

required

Response

Get agentic workflow

string<uuid>

required

created_at

string<date-time>

required

read-only

service_type

enum<string>

required

type of the service (application, database, job, ...)

Available options:

APPLICATION,

DATABASE,

CONTAINER,

JOB,

HELM,

TERRAFORM,

ARGOCD_APP,

AGENTIC_WORKFLOW

environment

object

required

Show child attributes

name

string

required

name is case insensitive

slug

string

required

URL-friendly identifier derived from the name

description

string

required

webhook_ip_allowlist

string[]

required

CIDR ranges the incoming webhook request's source IP is checked against

docker_fragment

string

required

enabled

boolean

required

mcp

string

required

Raw JSON blob describing the MCP servers configured for this workflow

outputs

object[]

required

Show child attributes

model

object

required

Show child attributes

project_repositories

object[]

required

Show child attributes

agent_prompt

string

required

governance

object

required

Show child attributes

resources

object

required

Show child attributes

webhook

object

required

Show child attributes

updated_at

string<date-time>

read-only

icon_uri

string<uri>

Icon URI representing the agentic workflow.

⌘I