Get Instruction API Definition

The Get Instruction API enables you to retrieve the full definition of a specific behavioral instruction by its ID. This allows you to inspect the instruction's template, metadata, and version history.

Get Instruction Request and Response

To retrieve an instruction, send a GET request to /v2/instructions/{instruction_id}. The instruction_id is the unique identifier of the instruction you wish to retrieve.

The response contains the instruction's id, name, description, template, enabled status, version, and metadata.

Example Request

EXAMPLE REQUEST

Code example with bash syntax.bash

1

Example Response

EXAMPLE RESPONSE

Code example with json syntax.json

1

Error Responses

The API returns standard HTTP error codes with detailed error information:

HTTP Code	Error Code	Description
400	invalid_request	Invalid instruction_id format
401	unauthorized	Invalid or missing API key
403	forbidden	Insufficient permissions for accessing this instruction
404	not_found	Instruction with the specified ID does not exist
429	rate_limit_exceeded	Request rate limit exceeded