Skip to main content
POST
/
agent-runtimes
/
push-services
Register an agent push runtime service
curl --request POST \
  --url https://api.veryfront.com/agent-runtimes/push-services \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "service_name": "<string>",
  "base_url": "<string>",
  "service_key": "<string>",
  "scope_kind": "global",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agent_id": "<string>",
  "invoke_url": "<string>",
  "capabilities": {},
  "metadata": {},
  "version": "<string>",
  "runtime": "<string>",
  "region": "<string>"
}
'
{
  "service": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "service_name": "<string>",
    "service_key": "<string>",
    "scope_key": "<string>",
    "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "agent_id": "<string>",
    "base_url": "<string>",
    "invoke_url": "<string>",
    "version": "<string>",
    "runtime": "<string>",
    "region": "<string>",
    "last_heartbeat_at": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "capabilities": null,
    "metadata": null
  }
}

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Body

application/json
service_name
string
required
Required string length: 1 - 128
base_url
string<uri>
required
service_key
string
Required string length: 1 - 128
scope_kind
enum<string>
default:global
Available options:
global,
project
project_id
string<uuid> | null
agent_id
string | null
Required string length: 1 - 128
invoke_url
string<uri>
capabilities
object
metadata
object
version
string | null
Required string length: 1 - 128
runtime
string | null
Required string length: 1 - 128
region
string | null
Required string length: 1 - 128

Response

201 - application/json

Agent push runtime service registered

service
object
required