DataForSEO · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DataForSEO Appendix API

5 actions 5 updates phrasing extends openapi/dataforseo-appendix-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for DataForSEO's API. It is a proposal applied on top of the contract, not a document DataForSEO publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/v3/appendix/user_data'].get
$.paths['/v3/appendix/errors'].get
$.paths['/v3/appendix/webhook_resend'].post
$.paths['/v3/appendix/status'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for DataForSEO Appendix API
  version: 1.0.0
extends: openapi/dataforseo-appendix-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/v3/appendix/user_data'].get
  update:
    x-apievangelist-phrasing:
      intent: Check account usage, prices and spending
      effect: read
      questions:
      - How much have I spent on my DataForSEO account so far?
      - Where can I see my API usage, balance and per-endpoint prices?
      - Can I check my account details and limits through the API?
      instructions:
      - text: Show my current API usage, spending and account balance.
      - text: Pull my account details including the prices I'm charged per endpoint.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/appendix/errors'].get
  update:
    x-apievangelist-phrasing:
      intent: List possible API error codes
      effect: read
      questions:
      - What do the internal error codes and status messages returned by the API mean?
      - Is there a reference list of every error code the API can return?
      instructions:
      - text: Fetch the full list of API error codes and their messages so I can map them in my logs.
      - text: Get the reference table of HTTP response codes and internal error messages.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/appendix/webhook_resend'].post
  update:
    x-apievangelist-phrasing:
      intent: Resend task webhooks
      effect: write
      questions:
      - Can I get pingbacks or postbacks re-sent for tasks whose webhook I missed?
      - Will I be charged again if I resend a task's webhook?
      - How many tasks can I resend webhooks for in a single call?
      instructions:
      - text: Resend the postback webhooks for my last batch of completed tasks.
      - text: Re-deliver the pingbacks for tasks my server failed to receive.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/appendix/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of all APIs and endpoints
      effect: read
      questions:
      - Is any API or endpoint currently down or degraded?
      - Where can I see a description of an ongoing incident affecting the endpoints?
      instructions:
      - text: Check the current operational status of every API and endpoint.
      - text: Tell me whether any endpoints have an active issue right now and what it is.
      method: generated
      generated: '2026-10-01'