NylorunDocsBeta
Runtime APIAgents

Put an agent's definition

PUT
/v1/agents/{agentId}

Authorization

applicationKey
headerAuthorizationBearer <token>

An application key of the Tenant (PUT /v1/tenant/keys/{keyId}), or Studio's key, derived from the admin key. With Nylorun-Subject and Nylorun-Scopes, it acts for that person, narrowed to those scopes. Never accepted from a browser (Origin).

Path Parameters

agentId*string

Header Parameters

Nylorun-Protocol*string

The protocol version, 8

Nylorun-Subject?string

The person an application key acts for

Nylorun-Scopes?string

The subject's space-separated scopes; required with a subject

Request Body

application/json
  1. body
requestId*string
Length1 <= length
manifest*|
implementationVersion*string
Length1 <= length

Response Body

The definition, stored

application/json
  1. response
agentId*string
manifestHash*string
implementationVersion*string
import { createClient } from "@nylorun/agents";const client = await createClient();await client.saveAgent(assistant);
{  "agentId": "string",  "manifestHash": "string",  "implementationVersion": "string"}

Get the Runtime API's document (alias) GET

Previous Page

List agents GET

With an application key, every definition, manifest included. With a trusted issuer's token, only the agents it may use, by name.