Ryze AI API

openapi: 3.1.0
info:
  title: Ryze AI API
  version: '2026-11-09'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-09: 6 operation(s) read from 5 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Ryze AI has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 6
    documentation: 0
    pages-with-code: 5
    pages-read: 5
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-09'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://help.get-ryze.ai/agent-api
  - https://help.get-ryze.ai/paid-ads/ryze-pixel
  - https://www.get-ryze.ai/google-ads-mcp
  - https://www.get-ryze.ai/meta-ads-mcp
  - https://www.get-ryze.ai/google-analytics-mcp
servers:
- url: https://reports.get-ryze.ai
paths:
  /api/v1/agent/signup:
    post:
      operationId: post_api_v1_agent_signup
      tags:
      - Api
      summary: POST /api/v1/agent/signup
      x-source: https://help.get-ryze.ai/agent-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1AgentSignupRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiV1AgentSignupResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://reports.get-ryze.ai/api/v1/agent/signup  -H \"Content-Type: application/json\"  -d '{ \"email\": \"you@company.com\"\
          \ }' \n Ryze emails an 8-digit code with the subject ”… is your Ryze code” . It is valid for 1 hour. The email tells the user to share\
          \ it only with their own agent. Calling signup again sends a new code; use the newest one. \n ​ 2. Verify \n You give the agent the\
          \ code. Th"
  /api/v1/agent/verify:
    post:
      operationId: post_api_v1_agent_verify
      tags:
      - Api
      summary: POST /api/v1/agent/verify
      x-source: https://help.get-ryze.ai/agent-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1AgentVerifyRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiV1AgentVerifyResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://reports.get-ryze.ai/api/v1/agent/verify  -H \"Content-Type: application/json\"  -d '{ \"email\": \"you@company.com\"\
          , \"code\": \"12345678\", \"domain\": \"company.com\", \"name\": \"My agent\" }' \n domain is the business website. Free email domains\
          \ such as gmail.com are refused. \n name is optional and labels the key in your settings. \n The response carries the key. It is shown\
          \ once, so the age"
  /api/v1/tools:
    get:
      operationId: get_api_v1_tools
      tags:
      - Api
      summary: GET /api/v1/tools
      x-source: https://help.get-ryze.ai/agent-api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl https://reports.get-ryze.ai/api/v1/tools  -H \"Authorization: Bearer rk_live_...\" \n Call one by name. Arguments go inside\
          \ args : "
  /api/v1/tools/{name}:
    post:
      operationId: post_api_v1_tools_name
      tags:
      - Api
      summary: Call a tool by name, passing arguments inside an "args" object.
      x-source: https://help.get-ryze.ai/agent-api
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1ToolsNameRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /mcp.:
    get:
      operationId: get_mcp
      tags:
      - Mcp
      summary: GET /mcp.
      x-source: https://www.get-ryze.ai/google-ads-mcp
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: httpie
        snippet: http https://connector.get-ryze.ai/mcp. In claude.ai, Claude Desktop, ChatGPT or Cursor open Settings, Connectors, Add custom
          connector, and paste https://connector.get-ryze.ai/mcp. Sign in with the Google account that owns the ads and pick the accounts to share.
          No developer token, Google Cloud pro
  /s2s:
    post:
      operationId: post_s2s
      tags:
      - S2S
      summary: POST /s2s
      x-source: https://help.get-ryze.ai/paid-ads/ryze-pixel
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostS2SRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://px.get-ryze.ai/s2s  -H \"x-ryze-key: rz_pk_YOUR_PUBLIC_KEY\"  -H \"Authorization: Bearer rz_sk_YOUR_SECRET_KEY\"\
          \  -H \"Content-Type: application/json\"  -d '{\"events\":[{\"event\":\"purchase\",\"order_id\":\"48213\",\"value\":129,\"currency\"\
          :\"USD\", \n \"user\":{\"email\":\"jane@example.com\",\"phone\":\"+14155550100\"}, \n \"contents\":[{\"id\":\"sku-1\",\"quantity\":1,\"\
          item_price\":129}]}]}' \n Every event needs an"
components:
  schemas:
    PostApiV1AgentSignupRequest:
      type: object
      properties:
        email:
          type: string
    PostApiV1AgentSignupResponse:
      type: object
      properties:
        api_key:
          type: string
        workspace_id:
          type: string
        mcp_url:
          type: string
        api_url:
          type: string
        docs_url:
          type: string
    PostApiV1AgentVerifyRequest:
      type: object
      properties:
        email:
          type: string
        code:
          type: string
        domain:
          type: string
        name:
          type: string
    PostApiV1AgentVerifyResponse:
      type: object
      properties:
        api_key:
          type: string
        workspace_id:
          type: string
        mcp_url:
          type: string
        api_url:
          type: string
        docs_url:
          type: string
    PostApiV1ToolsNameRequest:
      type: object
      properties:
        args:
          type: object
          description: Arguments for the tool. May include a "workspace" field when the key covers multiple workspaces.
      required:
      - args
    PostS2SRequest:
      type: object
      properties:
        events:
          type: array
          items:
            type: object
            properties:
              event:
                type: string
              order_id:
                type: string
              value:
                type: integer
              currency:
                type: string
              user:
                type: object
                properties:
                  email:
                    type: string
                  phone:
                    type: string
              contents:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                    quantity:
                      type: integer
                    item_price:
                      type: integer
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Api
- name: Mcp
- name: S2S