{"openapi":"3.1.0","jsonSchemaDialect":"https://spec.openapis.org/oas/3.1/dialect/base","info":{"title":"Aiso Public Agent API","version":"1.0.0","description":"Public, read-only endpoints that help software agents discover Aiso, choose an AI search workflow, and retrieve current pricing. Account and project data use the authenticated API documented at https://www.getaiso.com/docs.","termsOfService":"https://www.getaiso.com/quick_links/terms_of_service","contact":{"name":"Aiso support","url":"https://www.getaiso.com/contact","email":"support@getaiso.com"},"x-logo":{"url":"https://www.getaiso.com/logo2-white-bg-transparent.png","altText":"Aiso logo"}},"servers":[{"url":"https://www.getaiso.com","description":"Aiso production website"}],"externalDocs":{"description":"Aiso developer portal","url":"https://www.getaiso.com/developers"},"tags":[{"name":"Discovery","description":"Entry points for API and agent resource discovery."},{"name":"Agent routing","description":"Capabilities and workflow guidance for software agents."},{"name":"Pricing","description":"Current public plan and trial information."}],"paths":{"/api":{"get":{"tags":["Discovery"],"summary":"Discover Aiso's public APIs","description":"Returns canonical links for the OpenAPI document, public agent API, pricing data, authenticated API documentation, llms.txt, and Agent Skills index.","operationId":"getAisoApiIndex","x-agent-use-when":"Call this first when an agent has found Aiso but does not yet know which machine-readable resource to use.","responses":{"200":{"description":"Aiso API discovery index.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiIndex"}}}},"default":{"description":"Structured API problem.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}},"security":[]}},"/api/agent/v1":{"get":{"tags":["Agent routing"],"summary":"Read the Aiso agent API index","description":"Explains when an agent should use Aiso, lists supported audiences and workflow job identifiers, and links to capability and workflow endpoints.","operationId":"getAisoAgentApiIndex","x-agent-use-when":"Call this when deciding whether Aiso fits an AI search visibility, prompt research, fan-out, citation, crawlability, API, or MCP task.","responses":{"200":{"description":"Aiso agent routing index.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentApiIndex"}}}},"default":{"description":"Structured API problem.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}},"security":[]}},"/api/agent/v1/capabilities":{"get":{"tags":["Agent routing"],"summary":"List Aiso capabilities","description":"Returns Aiso capabilities and explicit use-when guidance. Optionally filter the result for a brand, agency, investor, or developer.","operationId":"listAisoCapabilities","x-agent-use-when":"Call this when an agent needs to map a user's role and job to the most relevant Aiso product or developer surface.","parameters":[{"name":"audience","in":"query","required":false,"description":"Return only capabilities relevant to this audience.","schema":{"$ref":"#/components/schemas/Audience"}}],"responses":{"200":{"description":"Matching Aiso capabilities.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapabilitiesResponse"}}}},"400":{"description":"The audience query parameter is not supported.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"default":{"description":"Structured API problem.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}},"security":[]}},"/api/agent/v1/workflows/{job}":{"get":{"tags":["Agent routing"],"summary":"Get routing guidance for an Aiso workflow","description":"Returns the appropriate Aiso interface, required inputs, authentication boundary, execution steps, and expected output for one supported job.","operationId":"getAisoWorkflow","x-agent-use-when":"Call this after identifying the user's job and before asking for credentials or invoking an authenticated Aiso interface.","parameters":[{"name":"job","in":"path","required":true,"description":"Published Aiso workflow identifier.","schema":{"$ref":"#/components/schemas/WorkflowJob"}}],"responses":{"200":{"description":"Workflow routing guidance.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowResponse"}}}},"404":{"description":"The requested workflow is not published.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"default":{"description":"Structured API problem.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}},"security":[]}},"/api/pricing":{"get":{"tags":["Pricing"],"summary":"Get current Aiso pricing","description":"Returns current public plan names, audiences, prices, features, trial terms, and calls to action from the same pricing data used by the website.","operationId":"getAisoPricing","x-agent-use-when":"Call this when a user asks about current Aiso plans, trial terms, or whether a plan uses standard or custom pricing.","responses":{"200":{"description":"Current Aiso pricing data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PricingResponse"}}}},"500":{"description":"Pricing data could not be produced.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"default":{"description":"Structured API problem.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}},"security":[]}}},"components":{"schemas":{"ProblemDetails":{"type":"object","description":"RFC 9457 problem details with stable Aiso resolution fields.","additionalProperties":false,"required":["type","title","status","detail","instance","code","resolution","documentation_url"],"properties":{"type":{"type":"string","format":"uri","description":"URI identifying the problem type."},"title":{"type":"string","description":"Short, human-readable problem title."},"status":{"type":"integer","minimum":400,"maximum":599,"description":"HTTP status code for this occurrence."},"detail":{"type":"string","description":"Specific explanation of what failed."},"instance":{"type":"string","description":"Request path where the problem occurred."},"code":{"type":"string","pattern":"^[a-z0-9_]+$","description":"Stable machine-readable Aiso error code."},"resolution":{"type":"string","description":"Concrete instruction for resolving the problem."},"documentation_url":{"type":"string","format":"uri","description":"Documentation for Aiso API errors."}},"example":{"type":"https://www.getaiso.com/developers#invalid-audience","title":"Invalid audience","status":400,"detail":"\"publisher\" is not a supported Aiso audience.","instance":"/api/agent/v1/capabilities","code":"invalid_audience","resolution":"Use one of: brand, agency, investor, developer.","documentation_url":"https://www.getaiso.com/developers#errors"}},"Provider":{"type":"object","additionalProperties":false,"required":["name","legal_name","website"],"properties":{"name":{"type":"string"},"legal_name":{"type":"string"},"website":{"type":"string","format":"uri"}}},"ApiIndex":{"type":"object","additionalProperties":false,"required":["name","description","version","provider","links","authentication"],"properties":{"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"string"},"provider":{"$ref":"#/components/schemas/Provider"},"links":{"type":"object","additionalProperties":{"type":"string","format":"uri-reference"},"description":"Canonical machine-readable and developer resource URLs."},"authentication":{"type":"object","additionalProperties":false,"required":["public_endpoints","account_data"],"properties":{"public_endpoints":{"type":"string"},"account_data":{"type":"string"}}}}},"AgentApiIndex":{"type":"object","additionalProperties":false,"required":["name","version","description","when_to_use","audiences","capabilities_url","workflow_url_template","supported_jobs","authentication","documentation_url","openapi_url"],"properties":{"name":{"type":"string"},"version":{"type":"string"},"description":{"type":"string"},"when_to_use":{"type":"string"},"audiences":{"type":"array","items":{"$ref":"#/components/schemas/Audience"}},"capabilities_url":{"type":"string","format":"uri-template"},"workflow_url_template":{"type":"string","format":"uri-template"},"supported_jobs":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowJob"}},"authentication":{"type":"string"},"documentation_url":{"type":"string","format":"uri"},"openapi_url":{"type":"string","format":"uri"}}},"Audience":{"type":"string","enum":["brand","agency","investor","developer"],"description":"Audience used to filter Aiso capabilities."},"Capability":{"type":"object","additionalProperties":false,"required":["id","name","description","use_when","audiences","product_url","requires_authentication"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"use_when":{"type":"string","description":"Routing guidance for deciding when this capability fits."},"audiences":{"type":"array","items":{"$ref":"#/components/schemas/Audience"}},"product_url":{"type":"string","format":"uri"},"requires_authentication":{"type":"boolean"}}},"CapabilitiesResponse":{"type":"object","additionalProperties":false,"required":["audience","count","capabilities"],"properties":{"audience":{"oneOf":[{"$ref":"#/components/schemas/Audience"},{"type":"string","const":"all"}]},"count":{"type":"integer","minimum":0},"capabilities":{"type":"array","items":{"$ref":"#/components/schemas/Capability"}}}},"WorkflowJob":{"type":"string","enum":["audit-ai-search-visibility","find-real-ai-prompts","track-brand-mentions","find-fan-out-queries","analyze-ai-citations","connect-api-or-mcp"],"description":"Published Aiso job identifier."},"Workflow":{"type":"object","additionalProperties":false,"required":["job","name","use_aiso_when","recommended_interface","start_url","required_inputs","authentication","steps","output"],"properties":{"job":{"$ref":"#/components/schemas/WorkflowJob"},"name":{"type":"string"},"use_aiso_when":{"type":"string"},"recommended_interface":{"type":"string","enum":["website","authenticated-api","mcp"]},"start_url":{"type":"string","format":"uri"},"required_inputs":{"type":"array","items":{"type":"string"}},"authentication":{"type":"string"},"steps":{"type":"array","minItems":1,"items":{"type":"string"}},"output":{"type":"string"}}},"WorkflowResponse":{"type":"object","additionalProperties":false,"required":["workflow"],"properties":{"workflow":{"$ref":"#/components/schemas/Workflow"}}},"Trial":{"type":"object","additionalProperties":false,"required":["durationDays","noCreditCardRequired"],"properties":{"durationDays":{"type":"integer","minimum":0},"noCreditCardRequired":{"type":"boolean"}}},"StandardPricing":{"type":"object","additionalProperties":false,"required":["type","monthly","yearly","currency"],"properties":{"type":{"type":"string","const":"standard"},"monthly":{"type":"number","minimum":0},"yearly":{"type":"number","minimum":0},"currency":{"type":"string","pattern":"^[A-Z]{3}$"}}},"CustomPricing":{"type":"object","additionalProperties":false,"required":["type","description"],"properties":{"type":{"type":"string","const":"custom"},"description":{"type":"string"}}},"PlanCta":{"type":"object","additionalProperties":false,"required":["text","url"],"properties":{"text":{"type":"string"},"url":{"type":"string","format":"uri-reference"}}},"PricingPlan":{"type":"object","additionalProperties":false,"required":["id","audience","name","description","trackedPrompts","pricing","features","cta"],"properties":{"id":{"type":"string"},"audience":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"trackedPrompts":{"oneOf":[{"type":"string"},{"type":"integer","minimum":0}]},"pricing":{"oneOf":[{"$ref":"#/components/schemas/StandardPricing"},{"$ref":"#/components/schemas/CustomPricing"}]},"features":{"type":"array","items":{"type":"string"}},"cta":{"$ref":"#/components/schemas/PlanCta"}}},"PricingResponse":{"type":"object","additionalProperties":false,"required":["provider","description","currency","url","trial","plans"],"properties":{"provider":{"type":"string"},"description":{"type":"string"},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"url":{"type":"string","format":"uri"},"trial":{"$ref":"#/components/schemas/Trial"},"plans":{"type":"array","items":{"$ref":"#/components/schemas/PricingPlan"}}}}}}}