Read an authored tool | Rasen Developer API

{
  "id": "tool_01j00000000000000000000000",
  "agent_id": "agent_01j00000000000000000000000",
  "revision": "example",
  "configuration": {
    "kind": "webhook",
    "deadline_ms": 8000,
    "definition": {
      "url": "https://api.example.com/orders",
      "method": "GET",
      "headers": [
        {
          "name": "Authorization",
          "value_type": "secret",
          "credential": {
            "secret_id": "sec_01j00000000000000000000000",
            "version": 1
          },
          "variable": "customer_name"
        }
      ],
      "parameters": [
        {
          "name": "lookup_order",
          "location": "path",
          "source": "model",
          "value": "example",
          "required": false,
          "schema": {
            "type": "string",
            "enum": [
              "example"
            ],
            "description": "example",
            "minimum": 1,
            "maximum": 1
          }
        }
      ],
      "content_type": "application/json"
    },
    "description": "example",
    "effect_id_name": "example",
    "effect_id_placement": "header",
    "max_response_bytes": 32768,
    "name": "lookup_order",
    "retry_posture": "none",
    "side_effect": "none",
    "wait_for_response": true
  },
  "created_at": "2026-09-25T10:00:00Z"
}

Safe configuration with versioned customer credential references. ETag is the complete draft revision.

Authentication

AuthorizationBearer

Create and manage workspace-owned keys through the existing app session routes, outside this public API. Creator and manager identities are audit actors only. Key validity follows workspace policy, expiry and explicit revocation, independently of creator membership. Do not include a workspace-selection header.

Path parameters

agent_idstringRequired1-128 characters

Resource identity within the authenticated workspace.

tool_idstringRequired1-128 characters

Resource identity within the authenticated workspace.

Response headers

X-Request-IdstringOptional

Safe server request correlation ID.

ETagstringOptional

Strong draft revision. Use this ETag for edits to this resource. Draft ETags cover complete authoring inputs.

RateLimit-LimitintegerOptional

Requests allowed in the current window for the tightest applicable limit.

RateLimit-RemainingintegerOptional

Requests left in the current window.

RateLimit-ResetintegerOptional

Seconds until the current window resets.

Response

Read an authored tool.

idstring<=128 characters

Opaque tool identifier. Do not parse its contents.

agent_idstring<=128 characters

Opaque agent identifier. Do not parse its contents.

revisionstring

configurationobject

created_atdatetime

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error