Get workflow inputs

Get the input variable names a workflow accepts at execution time

GET /agents/{agentId}/workflows/{workflowId}/inputs

Get workflow inputs

cURL

curl --request GET \
  --url https://odyssey.asteroid.ai/agents/v2/agents/{agentId}/workflows/{workflowId}/inputs \
  --header 'X-Asteroid-Agents-Api-Key: <api-key>'

import requests

url = "https://odyssey.asteroid.ai/agents/v2/agents/{agentId}/workflows/{workflowId}/inputs"

headers = {"X-Asteroid-Agents-Api-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-Asteroid-Agents-Api-Key': '<api-key>'}};

fetch('https://odyssey.asteroid.ai/agents/v2/agents/{agentId}/workflows/{workflowId}/inputs', 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://odyssey.asteroid.ai/agents/v2/agents/{agentId}/workflows/{workflowId}/inputs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Asteroid-Agents-Api-Key: <api-key>"
  ],
]);

$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://odyssey.asteroid.ai/agents/v2/agents/{agentId}/workflows/{workflowId}/inputs"

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

	req.Header.Add("X-Asteroid-Agents-Api-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://odyssey.asteroid.ai/agents/v2/agents/{agentId}/workflows/{workflowId}/inputs")
  .header("X-Asteroid-Agents-Api-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://odyssey.asteroid.ai/agents/v2/agents/{agentId}/workflows/{workflowId}/inputs")

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

request = Net::HTTP::Get.new(url)
request["X-Asteroid-Agents-Api-Key"] = '<api-key>'

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

200

{
  "inputs": [
    {
      "name": "<string>",
      "required": true,
      "schema": {},
      "defaultValue": "<unknown>",
      "description": "<string>"
    }
  ]
}

{
  "code": 400,
  "message": "<string>"
}

{
  "code": 401,
  "message": "<string>"
}

{
  "code": 403,
  "message": "<string>"
}

{
  "code": 404,
  "message": "<string>"
}

{
  "code": 500,
  "message": "<string>"
}

Authorizations

X-Asteroid-Agents-Api-Key · string · header · required

Path Parameters

agentId · string<uuid> · required

The ID of the agent

workflowId · string<uuid> · required

The ID of the workflow

Response

200

application/json

The request has succeeded.

The typed inputs a workflow declares

inputs · object[] · required

Typed input definitions the workflow accepts at execution time

Show child attributes