Give Feedback

pydo.output_views.validate()

Generated on 1 Oct 2026 from pydo version v0.43.0

Copy page as Markdown View page as Markdown

Usage

client.output_views.validate(
    body={
        "tool": "exa_web_search",
        "tool_id": "",
        "name": "titles-and-urls",
        ...,
    },
)

Returns JSONRaises HttpResponseError

Description

Validates a projection exactly as create does and returns the view it would produce, including output_schema, without storing anything. name and description are optional here; name uniqueness and the per-tool-version limit are not checked.

Parameters

tool string optional

Example: exa_web_search

Tool slug, optionally pinned; as on create.

tool_id string optional

Opaque ID of the tool version; as on create.

name string optional

Example: titles-and-urls

Optional view name, validated as on create when present.

description string optional

Example: Keep only result titles and URLs.

Optional description, validated as on create when present.

fields array of strings required

Example: ['results.title', 'results.url']

Output paths to keep; as on create.

Request Sample

Show Request Sample

import os
from pydo import Client

client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))

req = {
  "tool": "exa_web_search",
  "fields": [
    "results.title",
    "results.url"
  ]
}

resp = client.output_views.validate(body=req)

Response Example

Show Response Example

{
  "view": {
    "view_id": "",
    "tool_id": "tul_exa_web_search",
    "tool": "exa_web_search",
    "version": "v1",
    "team_id": "123456",
    "name": "titles-and-urls",
    "description": "Keep only result titles and URLs.",
    "kind": "OUTPUT_VIEW_KIND_PROJECTION",
    "fields": [
      "results.title",
      "results.url"
    ],
    "output_schema": {
      "type": "object",
      "properties": {
        "results": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "title": {
                "type": "string"
              },
              "url": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "audit": null
  }
}

More Information

See /v2/action-gateway/output-views/preview in the API reference for additional detail on responses, headers, parameters, and more.