{ "openapi": "3.0.3", "info": { "title": "Agentrail API", "version": "0.0.0" }, "tags": [ { "name": "Leaderboard" }, { "name": "Feedback" } ], "paths": { "/v1/leaderboard": { "get": { "operationId": "listLeaderboard", "summary": "Read the leaderboard: companies ranked by agent-readiness score, with their movement over 7 days", "parameters": [ { "schema": { "type": "string", "maxLength": 120, "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$" }, "in": "query", "name": "category", "required": false }, { "schema": { "type": "string", "enum": [ "include" ] }, "in": "query", "name": "community", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 120 }, "in": "query", "name": "q", "required": false }, { "schema": { "default": "score", "type": "string", "enum": [ "score", "company", "category", "scanned" ] }, "in": "query", "name": "sort", "required": false }, { "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "in": "query", "name": "order", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "in": "query", "name": "cursor", "required": false }, { "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "limit", "required": false } ], "security": [], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "rank": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "maximum": 9007199254740991 }, "company": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string", "minLength": 1 }, "website": { "type": "string", "format": "uri" }, "domain": { "type": "string", "minLength": 1 }, "category": { "nullable": true, "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string", "minLength": 1 }, "slug": { "type": "string", "maxLength": 120, "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$" } }, "required": [ "id", "name", "slug" ], "additionalProperties": false }, "source": { "type": "string", "enum": [ "curated", "community" ] } }, "required": [ "id", "name", "website", "domain", "category", "source" ], "additionalProperties": false }, "score": { "type": "integer", "minimum": 0, "maximum": 100 }, "grade": { "type": "string", "enum": [ "A+", "A", "B", "C", "D", "F" ] }, "scoreChange7d": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "rankChange7d": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "newThisWeek": { "type": "boolean" }, "scannedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" } }, "required": [ "rank", "company", "score", "grade", "scoreChange7d", "rankChange7d", "newThisWeek", "scannedAt" ], "additionalProperties": false } }, "nextCursor": { "nullable": true, "type": "string", "minLength": 1, "maxLength": 2048 }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "items", "nextCursor", "total" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "413": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "502": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } } }, "tags": [ "Leaderboard" ], "servers": [ { "url": "https://api.agentrail.co" } ], "x-mint": { "href": "/api-reference/leaderboard/list-leaderboard", "metadata": { "sidebarTitle": "List leaderboard" } } } }, "/v1/leaderboard/categories": { "get": { "operationId": "listLeaderboardCategories", "summary": "List the leaderboard's categories", "security": [], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string", "minLength": 1 }, "slug": { "type": "string", "maxLength": 120, "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$" } }, "required": [ "id", "name", "slug" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "413": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "502": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } } }, "tags": [ "Leaderboard" ], "servers": [ { "url": "https://api.agentrail.co" } ], "x-mint": { "href": "/api-reference/leaderboard/list-leaderboard-categories", "metadata": { "sidebarTitle": "List leaderboard categories" } } } }, "/v1/leaderboard/companies/{domain}": { "get": { "operationId": "getLeaderboardCompany", "summary": "Read one leaderboard company by its domain: its score, grade, ranks, 7-day changes, and its current scan's summary, layers and checks", "parameters": [ { "schema": { "type": "string", "enum": [ "include" ] }, "in": "query", "name": "community", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 253 }, "in": "path", "name": "domain", "required": true } ], "security": [], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string", "minLength": 1 }, "website": { "type": "string", "format": "uri" }, "domain": { "type": "string", "minLength": 1 }, "category": { "nullable": true, "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "name": { "type": "string", "minLength": 1 }, "slug": { "type": "string", "maxLength": 120, "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$" } }, "required": [ "id", "name", "slug" ], "additionalProperties": false }, "source": { "type": "string", "enum": [ "curated", "community" ] }, "score": { "nullable": true, "type": "integer", "minimum": 0, "maximum": 100 }, "grade": { "nullable": true, "type": "string", "enum": [ "A+", "A", "B", "C", "D", "F" ] }, "rank": { "nullable": true, "type": "integer", "minimum": 0, "exclusiveMinimum": true, "maximum": 9007199254740991 }, "rankedCompanies": { "nullable": true, "type": "integer", "minimum": 0, "exclusiveMinimum": true, "maximum": 9007199254740991 }, "categoryRank": { "nullable": true, "type": "integer", "minimum": 0, "exclusiveMinimum": true, "maximum": 9007199254740991 }, "categoryRankedCompanies": { "nullable": true, "type": "integer", "minimum": 0, "exclusiveMinimum": true, "maximum": 9007199254740991 }, "scoreChange7d": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "rankChange7d": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "newThisWeek": { "nullable": true, "type": "boolean" }, "scannedAt": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "summary": { "nullable": true, "type": "string", "minLength": 1 }, "layers": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "enum": [ "discovery", "access", "usability", "payments" ] }, "weight": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "maximum": 9007199254740991 }, "score": { "nullable": true, "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "weight", "score" ], "additionalProperties": false } }, "checks": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "layer": { "type": "string", "enum": [ "discovery", "access", "usability", "payments" ] }, "tier": { "type": "string", "enum": [ "required", "recommended", "emerging" ] }, "label": { "nullable": true, "type": "string", "enum": [ "emerging", "beta" ] }, "bonus": { "type": "boolean" }, "status": { "type": "string", "enum": [ "passed", "warning", "failed", "not_applicable", "couldnt_check" ] }, "earned": { "type": "number", "minimum": 0 }, "points": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "maximum": 9007199254740991 } }, "required": [ "id", "name", "layer", "tier", "label", "bonus", "status", "earned", "points" ], "additionalProperties": false } } }, "required": [ "id", "name", "website", "domain", "category", "source", "score", "grade", "rank", "rankedCompanies", "categoryRank", "categoryRankedCompanies", "scoreChange7d", "rankChange7d", "newThisWeek", "scannedAt", "summary", "layers", "checks" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "413": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "502": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } } }, "tags": [ "Leaderboard" ], "servers": [ { "url": "https://api.agentrail.co" } ], "x-mint": { "href": "/api-reference/leaderboard/get-leaderboard-company", "metadata": { "sidebarTitle": "Get leaderboard company" } } } }, "/v1/leaderboard/scans": { "post": { "operationId": "startLeaderboardScan", "summary": "Scan a website, MCP server or MCP App for agent readiness, or join its scan already running; optionally be emailed when it ends", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "minLength": 1, "maxLength": 2048 }, "email": { "type": "string", "maxLength": 254 } }, "required": [ "url" ], "additionalProperties": false } } } }, "security": [], "responses": { "202": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "started": { "type": "boolean" }, "scan": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "state": { "type": "string", "enum": [ "waiting", "running", "scoring", "ended" ] } }, "required": [ "id", "state" ], "additionalProperties": false }, "domain": { "type": "string", "minLength": 1 } }, "required": [ "started", "scan", "domain" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "413": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "502": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } } }, "tags": [ "Leaderboard" ], "servers": [ { "url": "https://api.agentrail.co" } ], "x-mint": { "href": "/api-reference/leaderboard/start-leaderboard-scan", "metadata": { "sidebarTitle": "Start leaderboard scan", "playground": "simple" } } } }, "/v1/leaderboard/scans/{scanId}": { "get": { "operationId": "getLeaderboardScan", "summary": "Read a leaderboard scan as it stands: waiting, running, being scored, or ended with its score", "parameters": [ { "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-8][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "in": "path", "name": "scanId", "required": true } ], "security": [], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "state": { "type": "string", "enum": [ "waiting", "running", "scoring", "ended" ] }, "ending": { "nullable": true, "type": "string", "enum": [ "finished", "failed", "interrupted", "sign_in_required" ] }, "cause": { "nullable": true, "type": "string", "minLength": 1 }, "domain": { "type": "string", "minLength": 1 }, "score": { "nullable": true, "type": "integer", "minimum": 0, "maximum": 100 }, "grade": { "nullable": true, "type": "string", "enum": [ "A+", "A", "B", "C", "D", "F" ] }, "endedAt": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "events": { "type": "array", "items": { "type": "object", "properties": { "step": { "type": "string", "enum": [ "waiting", "reading", "robots", "homepage", "indexes", "agent_views", "mcp", "dns", "agent_files", "api_descriptions", "probes", "pages", "scoring", "product_facts", "developer_checks", "lookups", "checks", "summary", "ended" ] }, "at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" } }, "required": [ "step", "at" ], "additionalProperties": false } } }, "required": [ "id", "state", "ending", "cause", "domain", "score", "grade", "endedAt", "events" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "413": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "502": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } } }, "tags": [ "Leaderboard" ], "servers": [ { "url": "https://api.agentrail.co" } ], "x-mint": { "href": "/api-reference/leaderboard/get-leaderboard-scan", "metadata": { "sidebarTitle": "Get leaderboard scan" } } } }, "/v1/leaderboard/companies/{domain}/journeys": { "get": { "operationId": "listLeaderboardCompanyJourneys", "summary": "Read a company's agent journeys: each task's latest one, and any running", "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 253 }, "in": "path", "name": "domain", "required": true } ], "security": [], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "task": { "type": "string", "enum": [ "understand_product", "find_pricing", "get_started", "api_docs", "create_account", "get_support" ] }, "state": { "type": "string", "enum": [ "waiting", "running", "ended" ] }, "ending": { "nullable": true, "type": "string", "enum": [ "answered", "not_answered" ] }, "agent": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "version": { "nullable": true, "type": "string", "minLength": 1 }, "model": { "type": "string", "minLength": 1 } }, "required": [ "name", "version", "model" ], "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "endedAt": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" } }, "required": [ "id", "task", "state", "ending", "agent", "createdAt", "endedAt" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "413": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "502": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } } }, "tags": [ "Leaderboard" ], "servers": [ { "url": "https://api.agentrail.co" } ], "x-mint": { "href": "/api-reference/leaderboard/list-leaderboard-company-journeys", "metadata": { "sidebarTitle": "List leaderboard company journeys" } } }, "post": { "operationId": "startLeaderboardJourney", "summary": "Run an agent journey on one of a company's tasks, or watch the one already running", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "task": { "type": "string", "enum": [ "understand_product", "find_pricing", "get_started", "api_docs", "create_account", "get_support" ] } }, "required": [ "task" ], "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 253 }, "in": "path", "name": "domain", "required": true } ], "security": [], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "started": { "type": "boolean" }, "journey": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "state": { "type": "string", "enum": [ "waiting", "running", "ended" ] } }, "required": [ "id", "state" ], "additionalProperties": false } }, "required": [ "started", "journey" ], "additionalProperties": false } } } }, "202": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "started": { "type": "boolean" }, "journey": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "state": { "type": "string", "enum": [ "waiting", "running", "ended" ] } }, "required": [ "id", "state" ], "additionalProperties": false } }, "required": [ "started", "journey" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "413": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "502": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } } }, "tags": [ "Leaderboard" ], "servers": [ { "url": "https://api.agentrail.co" } ], "x-mint": { "href": "/api-reference/leaderboard/start-leaderboard-journey", "metadata": { "sidebarTitle": "Start leaderboard journey", "playground": "simple" } } } }, "/v1/leaderboard/journeys/{journeyId}": { "get": { "operationId": "getLeaderboardJourney", "summary": "Read an agent journey step by step: every search and page, how each page was found, and the agent's answer", "parameters": [ { "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-8][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$" }, "in": "path", "name": "journeyId", "required": true } ], "security": [], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "task": { "type": "string", "enum": [ "understand_product", "find_pricing", "get_started", "api_docs", "create_account", "get_support" ] }, "state": { "type": "string", "enum": [ "waiting", "running", "ended" ] }, "ending": { "nullable": true, "type": "string", "enum": [ "answered", "not_answered" ] }, "agent": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "version": { "nullable": true, "type": "string", "minLength": 1 }, "model": { "type": "string", "minLength": 1 } }, "required": [ "name", "version", "model" ], "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "endedAt": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "companyDomain": { "type": "string", "minLength": 1 }, "prompt": { "nullable": true, "type": "string", "minLength": 1 }, "steps": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "search" ] }, "query": { "type": "string" }, "results": { "type": "array", "items": { "type": "string", "minLength": 1 } }, "error": { "nullable": true, "type": "string", "minLength": 1 }, "pending": { "type": "boolean" } }, "required": [ "kind", "query", "results", "error", "pending" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "page" ] }, "url": { "type": "string", "minLength": 1 }, "found": { "type": "string", "enum": [ "task", "search_result", "page_link", "typed" ] }, "hops": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "minLength": 1 }, "status": { "nullable": true, "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "location": { "nullable": true, "type": "string", "minLength": 1 }, "contentType": { "nullable": true, "type": "string", "minLength": 1 }, "bytes": { "nullable": true, "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "error": { "nullable": true, "type": "string", "minLength": 1 } }, "required": [ "url", "status", "location", "contentType", "bytes", "error" ], "additionalProperties": false } }, "outcome": { "type": "string", "enum": [ "loaded", "failed", "sent_elsewhere", "reused", "pending" ] }, "error": { "nullable": true, "type": "string", "minLength": 1 }, "format": { "nullable": true, "type": "string", "enum": [ "markdown", "html", "other" ] }, "ownSite": { "type": "boolean" }, "kinds": { "type": "array", "items": { "type": "string", "enum": [ "homepage", "pricing", "docs" ] } } }, "required": [ "kind", "url", "found", "hops", "outcome", "error", "format", "ownSite", "kinds" ], "additionalProperties": false } ] } }, "answer": { "nullable": true, "type": "string" }, "facts": { "type": "object", "properties": { "openedOwnSite": { "type": "boolean" }, "pageKinds": { "type": "array", "items": { "type": "string", "enum": [ "homepage", "pricing", "docs" ] } }, "firstFailedStep": { "nullable": true, "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "openedOwnSite", "pageKinds", "firstFailedStep" ], "additionalProperties": false } }, "required": [ "id", "task", "state", "ending", "agent", "createdAt", "endedAt", "companyDomain", "prompt", "steps", "answer", "facts" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "413": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "502": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } } }, "tags": [ "Leaderboard" ], "servers": [ { "url": "https://api.agentrail.co" } ], "x-mint": { "href": "/api-reference/leaderboard/get-leaderboard-journey", "metadata": { "sidebarTitle": "Get leaderboard journey" } } } }, "/v1/feedback/{slug}": { "get": { "operationId": "getFeedbackProjectCard", "summary": "Read a feedback project's card: whether it accepts reports, its invitation, and where and how to send one", "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "slug", "required": true } ], "security": [], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "accepting": { "type": "boolean" }, "signedOnly": { "type": "boolean" }, "invitation": { "type": "string", "minLength": 1 }, "guidance": { "type": "string", "minLength": 1 }, "pageUrl": { "type": "string", "format": "uri" }, "collectionUrl": { "type": "string", "format": "uri" }, "reportSchemaUrl": { "type": "string", "format": "uri" }, "reportSchema": { "type": "object", "additionalProperties": {} } }, "required": [ "slug", "name", "accepting", "signedOnly", "invitation", "guidance", "pageUrl", "collectionUrl", "reportSchemaUrl", "reportSchema" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "413": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "502": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } } }, "tags": [ "Feedback" ], "servers": [ { "url": "https://feedback.agentrail.co" } ], "x-mint": { "href": "/api-reference/feedback/get-feedback-project-card", "metadata": { "sidebarTitle": "Get feedback project card" } } } }, "/v1/feedback/{slug}/schema": { "get": { "operationId": "getFeedbackReportSchema", "summary": "Read the JSON Schema of a feedback project's reports", "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "slug", "required": true } ], "security": [], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "413": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "502": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } } }, "tags": [ "Feedback" ], "servers": [ { "url": "https://feedback.agentrail.co" } ], "x-mint": { "href": "/api-reference/feedback/get-feedback-report-schema", "metadata": { "sidebarTitle": "Get feedback report schema" } } } }, "/v1/feedback/{slug}/reports": { "post": { "operationId": "submitFeedbackReport", "summary": "Send a feedback report: what you tried, what happened, and what was confusing or missing", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "observation": { "type": "string", "minLength": 10, "maxLength": 4000 }, "goal": { "type": "string", "minLength": 1, "maxLength": 500 }, "outcome": { "type": "string", "enum": [ "succeeded", "friction", "blocked" ] }, "category": { "type": "string", "enum": [ "documentation", "missing_capability", "error", "confusing_output", "access", "other" ] }, "reference": { "type": "string", "minLength": 1, "maxLength": 200 }, "surface": { "type": "string", "enum": [ "web", "api", "mcp", "cli", "other" ] }, "productVersion": { "type": "string", "minLength": 1, "maxLength": 64 }, "requestReference": { "type": "string", "minLength": 1, "maxLength": 128 }, "agent": { "type": "string", "minLength": 1, "maxLength": 200 }, "invite": { "type": "string", "minLength": 1, "maxLength": 64 }, "metadata": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "number" }, { "type": "boolean" }, { "type": "string", "nullable": true, "enum": [ null ] } ] } } }, "required": [ "observation" ], "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "slug", "required": true }, { "schema": { "type": "string", "pattern": "^\\d{1,12}$" }, "in": "header", "name": "feedback-timestamp", "required": false }, { "schema": { "type": "string", "pattern": "^[0-9a-f]{64}$" }, "in": "header", "name": "feedback-signature", "required": false } ], "security": [], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "receivedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "repeat": { "type": "boolean" }, "message": { "type": "string", "minLength": 1 } }, "required": [ "id", "receivedAt", "repeat", "message" ], "additionalProperties": false } } } }, "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "receivedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "repeat": { "type": "boolean" }, "message": { "type": "string", "minLength": 1 } }, "required": [ "id", "receivedAt", "repeat", "message" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "409": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "413": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "422": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "500": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "502": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "requestId": { "type": "string", "minLength": 1 } }, "required": [ "code", "message", "requestId" ], "additionalProperties": false } } } } }, "tags": [ "Feedback" ], "servers": [ { "url": "https://feedback.agentrail.co" } ], "x-mint": { "href": "/api-reference/feedback/submit-feedback-report", "metadata": { "sidebarTitle": "Submit feedback report", "playground": "simple" } } } } } }