Skip to main content
POST
/
agents
/
{agentId}
/
device-codes
cURL
curl --request POST \
  --url https://api.lightspark.com/grid/2025-10-13/agents/{agentId}/device-codes \
  --header 'Authorization: Basic <encoded-value>'
{
  "code": "GRID-AGENT-X7K9-M2P4",
  "agentId": "Agent:019542f5-b3e7-1d02-0000-000000000001",
  "expiresAt": "2025-07-22T17:32:28Z",
  "redeemed": false
}

Documentation Index

Fetch the complete documentation index at: https://ramps-docs-agents-webhook-and-account-model-links.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

API token authentication using format <api token id>:<api client secret>

Path Parameters

agentId
string
required

System-generated unique agent identifier

Response

New device code generated successfully

code
string
required

Human-readable device code used to install and connect the agent software.

Example:

"GRID-AGENT-X7K9-M2P4"

agentId
string
required

The agent this device code belongs to.

Example:

"Agent:019542f5-b3e7-1d02-0000-000000000001"

expiresAt
string<date-time>
required

Timestamp when this device code expires.

Example:

"2025-07-22T17:32:28Z"

redeemed
boolean
required

Whether this device code has already been redeemed by the agent.

Example:

false