REST API

Use the public REST API for deterministic automations and endpoint-level testing.

REST API

The public REST API exposes two canonical families:

  • /api/v1/commands/* for shared runtime commands
  • /api/v1/resources* for read-only workspace resources

For command execution, response_profile defaults to full. Use compact only when token savings matter more than prospecting quality. Compact responses can noticeably reduce the quality of prospecting decisions and personalization. Use GET /api/v1/commands/{commandId}/schema to inspect the public input_schema, output_schema, and approval_output_schema attached to each runtime command.

Command Catalog

GET
/api/v1/commands

Authorization

AuthorizationBearer <token>

Use Authorization: Bearer <salestouch_api_key>.

In: header

Response Body

application/json

application/json

application/json

curl -X GET "https://www.salestouch.io/api/v1/commands"
{
  "data": {
    "commands": [
      {
        "command_id": "string",
        "title": "string",
        "description": "string",
        "summary": "string",
        "visibility": "public",
        "risk": "read",
        "category": "linkedin",
        "default_permission": "allow",
        "when_to_use": "string",
        "risk_notes": [
          "string"
        ],
        "output_notes": [
          "string"
        ],
        "related_commands": [
          "string"
        ],
        "related_resources": [
          "string"
        ],
        "examples": [
          {
            "title": "string",
            "language": "string",
            "code": "string"
          }
        ]
      }
    ]
  }
}
{
  "error": {
    "message": "string",
    "code": "string"
  }
}
{
  "error": {
    "message": "string",
    "code": "string"
  }
}

Resource Catalog

GET
/api/v1/resources

Authorization

AuthorizationBearer <token>

Use Authorization: Bearer <salestouch_api_key>.

In: header

Response Body

application/json

application/json

application/json

curl -X GET "https://www.salestouch.io/api/v1/resources"
{
  "data": {
    "resources": [
      {
        "uri": "string",
        "name": "string",
        "title": "string",
        "description": "string",
        "summary": "string",
        "mimeType": "application/json",
        "related_commands": [
          "string"
        ]
      }
    ]
  }
}
{
  "error": {
    "message": "string",
    "code": "string"
  }
}
{
  "error": {
    "message": "string",
    "code": "string"
  }
}

On this page