{ "openapi": "3.1.0", "info": { "title": "Grafiduo Public API", "version": "1.0.0", "summary": "Read-only catalogue API of Grafiduo: company profile, services, plugins and pricing.", "description": "Public, read-only API of Grafiduo — a web design and development studio.\n\nNo authentication and no registration: every endpoint returns data that is already public on the website.\n\n**Rate limit.** 120 requests per 60 seconds per client IP. Every response carries `RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset` and `RateLimit-Policy`; over the limit the API answers `429` with `Retry-After`.\n\n**Errors.** Failures return the RFC 9457 problem shape (`type`, `title`, `status`, `detail`, `instance`) with the WordPress `code` / `message` / `data` fields kept alongside for compatibility.\n\n**Pagination.** Collections are cursor-based: read `nextCursor` (or the `Link: rel=\"next\"` header) and pass it back as `cursor`. Cursors are opaque — do not build them yourself.\n\n**Idempotency.** Send `Idempotency-Key` on any request and it is echoed back. Every operation is a GET, so retries are always safe and never duplicate anything.\n\n**Writes.** `POST /enquiries` is the only write. It answers `202 Accepted` with a `jobId` and a `statusUrl`; poll `GET /jobs/{id}` (honouring `Retry-After`) until `status` is `succeeded` or `failed`. Always send `Idempotency-Key` — the key is kept for 24 hours with the job it created, so a retry returns the same job instead of sending a second enquiry.\n\n**Versioning.** The version lives in the path (`/api/v1`). Breaking changes ship as a new path; retiring one is announced with `Deprecation` and `Sunset` headers plus a `Link: rel=\"successor-version\"`. See https://grafiduo.pl/developers/#versioning.\n\nProject work (websites, stores, audits, UX reviews) is scoped individually and has no public price list — use `contactUrl` from `/company` to hand the user off. Plugin prices are published in full under `/products`.", "termsOfService": "https://grafiduo.pl/privacy-policy/", "contact": { "name": "Grafiduo", "url": "https://grafiduo.pl/contact/", "email": "hello@grafiduo.pl" }, "x-api-version": "1.0.0", "x-deprecation-policy": "https://grafiduo.pl/developers/#versioning", "x-rate-limit": { "requests": 120, "windowSeconds": 60, "scope": "client IP address", "headers": [ "RateLimit-Limit", "RateLimit-Remaining", "RateLimit-Reset", "RateLimit-Policy", "Retry-After" ] }, "x-pagination": { "style": "cursor", "parameter": "cursor", "nextField": "nextCursor", "linkHeader": "Link; rel=\"next\"" }, "x-idempotency": { "header": "Idempotency-Key", "requiredOn": [ "createEnquiry" ], "retentionSeconds": 86400, "replayHeader": "Idempotency-Replayed", "description": "Required on writes, where the key is stored with its job so retries never duplicate anything. Accepted and echoed on reads, which are idempotent by method." }, "x-async": { "pattern": "poll", "acceptedStatus": 202, "pollOperationId": "getJob", "jobIdField": "jobId", "statusUrlField": "statusUrl", "terminalStatuses": [ "succeeded", "failed" ] } }, "servers": [ { "url": "https://grafiduo.pl/api/v1", "description": "Production" }, { "url": "https://grafiduo.pl/wp-json/grafiduo/v1", "description": "Production (canonical WordPress REST path)" } ], "externalDocs": { "description": "Developer portal", "url": "https://grafiduo.pl/developers/" }, "tags": [ { "name": "company", "description": "Who the studio is, what it does and how to get in touch." }, { "name": "catalogue", "description": "Services and off-the-shelf plugins with their pricing plans." }, { "name": "agents", "description": "Machine-readable resources for AI agents." }, { "name": "enquiries", "description": "Writes: sending a project enquiry. Idempotent through Idempotency-Key, executed asynchronously." }, { "name": "jobs", "description": "Polling the asynchronous jobs created by accepted writes." } ], "paths": { "/company": { "get": { "operationId": "getCompanyProfile", "summary": "Company profile, contact details and routing hints", "description": "Returns the studio profile together with `useWhen` / `doNotUseWhen` hints that tell an agent whether this site answers the user’s need.", "tags": [ "company" ], "parameters": [ { "name": "fields", "in": "query", "required": false, "description": "Restrict the response to these top-level fields.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "name", "tagline", "summary", "url", "email", "phone", "address", "contactUrl", "languages", "areaServed", "sameAs", "useWhen", "doNotUseWhen", "process" ] } }, "example": [ "name", "email", "contactUrl" ] }, { "name": "Idempotency-Key", "in": "header", "required": false, "description": "Client-generated key echoed back in the response. This operation is a GET and therefore idempotent — a retry with the same key is always safe.", "schema": { "type": "string", "maxLength": 255 }, "example": "6f1c1f1e-6a44-4c37-9b0f-2b4f2f2c9a10" } ], "responses": { "200": { "description": "Company profile", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company" } } } }, "400": { "description": "Malformed request — an unknown cursor, a missing field or a parameter outside its range.", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "No such resource or endpoint.", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded; retry after the number of seconds in Retry-After.", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Unexpected server error.", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "The operation is temporarily switched off.", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/services": { "get": { "operationId": "listServices", "summary": "List the service catalogue", "description": "Cursor-paginated. Project services are scoped individually; there is no public price list for them.", "tags": [ "catalogue" ], "parameters": [ { "name": "q", "in": "query", "required": false, "description": "Free-text filter matched against the name and description.", "schema": { "type": "string" }, "example": "wcag" }, { "name": "limit", "in": "query", "required": false, "description": "Page size — how many items to return.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque cursor taken from `nextCursor` of the previous page. Omit it for the first page; never construct one by hand.", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "description": "Client-generated key echoed back in the response. This operation is a GET and therefore idempotent — a retry with the same key is always safe.", "schema": { "type": "string", "maxLength": 255 }, "example": "6f1c1f1e-6a44-4c37-9b0f-2b4f2f2c9a10" } ], "responses": { "200": { "description": "Page of services", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } }, "Link": { "description": "Cursor pagination: `rel=\"next\"` points at the following page while one exists.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceList" } } } }, "400": { "description": "Malformed request — an unknown cursor, a missing field or a parameter outside its range.", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "No such resource or endpoint.", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded; retry after the number of seconds in Retry-After.", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Unexpected server error.", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "The operation is temporarily switched off.", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-pagination": { "style": "cursor", "cursorParam": "cursor", "limitParam": "limit", "nextField": "nextCursor", "totalField": "total", "itemsField": "items", "linkHeaderRel": "next" } } }, "/products": { "get": { "operationId": "listProducts", "summary": "List the off-the-shelf plugins with pricing", "description": "Cursor-paginated. Filter with `q`, then page by passing the response’s `nextCursor` back as `cursor` until it comes back null.", "tags": [ "catalogue" ], "parameters": [ { "name": "q", "in": "query", "required": false, "description": "Free-text filter matched against the name and description.", "schema": { "type": "string" }, "example": "wcag" }, { "name": "limit", "in": "query", "required": false, "description": "Page size — how many items to return.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque cursor taken from `nextCursor` of the previous page. Omit it for the first page; never construct one by hand.", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "description": "Client-generated key echoed back in the response. This operation is a GET and therefore idempotent — a retry with the same key is always safe.", "schema": { "type": "string", "maxLength": 255 }, "example": "6f1c1f1e-6a44-4c37-9b0f-2b4f2f2c9a10" } ], "responses": { "200": { "description": "Page of plugins", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } }, "Link": { "description": "Cursor pagination: `rel=\"next\"` points at the following page while one exists.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductList" } } } }, "400": { "description": "Malformed request — an unknown cursor, a missing field or a parameter outside its range.", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "No such resource or endpoint.", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded; retry after the number of seconds in Retry-After.", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Unexpected server error.", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "The operation is temporarily switched off.", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-pagination": { "style": "cursor", "cursorParam": "cursor", "limitParam": "limit", "nextField": "nextCursor", "totalField": "total", "itemsField": "items", "linkHeaderRel": "next" } } }, "/products/{id}": { "get": { "operationId": "getProduct", "summary": "Get one plugin with its plans and FAQ", "tags": [ "catalogue" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Product slug, as returned by `/products`.", "schema": { "type": "string", "pattern": "^[a-z0-9-]+$" }, "example": "wp-accessibility-wcag" }, { "name": "Idempotency-Key", "in": "header", "required": false, "description": "Client-generated key echoed back in the response. This operation is a GET and therefore idempotent — a retry with the same key is always safe.", "schema": { "type": "string", "maxLength": 255 }, "example": "6f1c1f1e-6a44-4c37-9b0f-2b4f2f2c9a10" } ], "responses": { "200": { "description": "One plugin", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } } } }, "400": { "description": "Malformed request — an unknown cursor, a missing field or a parameter outside its range.", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "No such resource or endpoint.", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded; retry after the number of seconds in Retry-After.", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Unexpected server error.", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "The operation is temporarily switched off.", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/resources": { "get": { "operationId": "getAgentResources", "summary": "URLs of every machine-readable resource", "description": "llms.txt, agents.md, the A2A agent card, the ARD manifest, this OpenAPI document, the MCP server endpoint, robots.txt and the sitemap.", "tags": [ "agents" ], "parameters": [ { "name": "fields", "in": "query", "required": false, "description": "Restrict the response to these resource keys.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "llmsTxt", "agentsMd", "agentCard", "ard", "openapi", "mcpServer", "mcpManifest", "developerPortal", "robotsTxt", "sitemap" ] } }, "example": [ "openapi", "mcpServer" ] }, { "name": "Idempotency-Key", "in": "header", "required": false, "description": "Client-generated key echoed back in the response. This operation is a GET and therefore idempotent — a retry with the same key is always safe.", "schema": { "type": "string", "maxLength": 255 }, "example": "6f1c1f1e-6a44-4c37-9b0f-2b4f2f2c9a10" } ], "responses": { "200": { "description": "Resource map", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Resources" } } } }, "400": { "description": "Malformed request — an unknown cursor, a missing field or a parameter outside its range.", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "No such resource or endpoint.", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded; retry after the number of seconds in Retry-After.", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Unexpected server error.", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "The operation is temporarily switched off.", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/enquiries": { "post": { "operationId": "createEnquiry", "summary": "Send a project enquiry", "description": "Queues a project enquiry and returns immediately with `202 Accepted`: the body carries `jobId` and `statusUrl`, and the `Location` header points at the same URL. Poll `GET /jobs/{id}` until `status` is `succeeded` or `failed` — `Retry-After` tells you how long to wait between polls.\n\n**Always send an `Idempotency-Key`.** The key is stored for 24 hours together with the job it created, so a retry after a network failure returns the original job with `Idempotency-Replayed: true` instead of sending a second enquiry.\n\nThe endpoint is public but throttled to a handful of enquiries per hour per address. The `website` field is a honeypot and must stay empty.", "tags": [ "enquiries" ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "description": "Client-generated key that makes the write safe to retry. The key is stored for 24 hours with the job it created; repeating the request with the same key returns that job instead of creating a second enquiry, and the response carries `Idempotency-Replayed: true`.", "schema": { "type": "string", "maxLength": 255 }, "example": "6f1c1f1e-6a44-4c37-9b0f-2b4f2f2c9a10" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnquiryInput" }, "example": { "name": "Ada Kowalska", "email": "ada@example.com", "company": "Example sp. z o.o.", "projectType": "web-development", "budget": "10 000 - 20 000 EUR", "deadline": "2026-11-30", "language": "en", "message": "We run a PrestaShop store and need a WCAG 2.1 AA audit plus remediation before the end of the year." } } } }, "responses": { "202": { "description": "Enquiry accepted; poll statusUrl for the outcome.", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } }, "Location": { "description": "URL to poll for the outcome — the same value as `statusUrl` in the body.", "schema": { "type": "string", "format": "uri" } }, "Retry-After": { "description": "Seconds to wait before polling again; sent while the job is queued or processing.", "schema": { "type": "integer" } }, "Idempotency-Replayed": { "description": "true when the response replays an earlier request carrying the same Idempotency-Key.", "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "400": { "description": "Malformed request — an unknown cursor, a missing field or a parameter outside its range.", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "No such resource or endpoint.", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded; retry after the number of seconds in Retry-After.", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Unexpected server error.", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "The operation is temporarily switched off.", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-idempotency": { "header": "Idempotency-Key", "required": true, "retentionSeconds": 86400, "replayHeader": "Idempotency-Replayed" }, "x-async": { "pattern": "poll", "acceptedStatus": 202, "jobIdField": "jobId", "statusField": "status", "statusUrlField": "statusUrl", "locationHeader": "Location", "retryAfterHeader": "Retry-After", "pollOperationId": "getJob", "terminalStatuses": [ "succeeded", "failed" ] } } }, "/jobs/{id}": { "get": { "operationId": "getJob", "summary": "Poll an async job", "description": "Returns the state of a job created by an accepted operation: `queued`, `processing`, `succeeded` or `failed`. While the job is not finished the response carries `Retry-After`. Jobs are kept for 24 hours.", "tags": [ "jobs" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Job identifier from the `jobId` field of the accepted response.", "schema": { "type": "string", "pattern": "^[a-f0-9-]{8,64}$" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "description": "Client-generated key echoed back in the response. This operation is a GET and therefore idempotent — a retry with the same key is always safe.", "schema": { "type": "string", "maxLength": 255 }, "example": "6f1c1f1e-6a44-4c37-9b0f-2b4f2f2c9a10" } ], "responses": { "200": { "description": "Current state of the job.", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } }, "Location": { "description": "URL to poll for the outcome — the same value as `statusUrl` in the body.", "schema": { "type": "string", "format": "uri" } }, "Retry-After": { "description": "Seconds to wait before polling again; sent while the job is queued or processing.", "schema": { "type": "integer" } }, "Idempotency-Replayed": { "description": "true when the response replays an earlier request carrying the same Idempotency-Key.", "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "400": { "description": "Malformed request — an unknown cursor, a missing field or a parameter outside its range.", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "No such resource or endpoint.", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded; retry after the number of seconds in Retry-After.", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Unexpected server error.", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "The operation is temporarily switched off.", "headers": { "RateLimit-Limit": { "description": "Requests allowed in the current window.", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests left in the current window.", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the window resets.", "schema": { "type": "integer" } }, "RateLimit-Policy": { "description": "Policy in force, e.g. `120;w=60`.", "schema": { "type": "string" } }, "API-Version": { "description": "Version of the API that served the response.", "schema": { "type": "string" } }, "Idempotency-Key": { "description": "Echo of the key sent with the request.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-async": { "pattern": "poll", "acceptedStatus": 202, "jobIdField": "jobId", "statusField": "status", "statusUrlField": "statusUrl", "locationHeader": "Location", "retryAfterHeader": "Retry-After", "pollOperationId": "getJob", "terminalStatuses": [ "succeeded", "failed" ] } } } }, "components": { "schemas": { "Company": { "type": "object", "title": "Company", "description": "Studio profile with the hints an agent needs to decide whether to route a user here.", "required": [ "name", "url", "email", "contactUrl" ], "properties": { "name": { "type": "string" }, "tagline": { "type": "string" }, "summary": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "email": { "type": "string", "format": "email" }, "phone": { "type": "string" }, "address": { "type": "string" }, "contactUrl": { "type": "string", "format": "uri" }, "languages": { "type": "array", "items": { "type": "string" } }, "areaServed": { "type": "string" }, "sameAs": { "type": "array", "items": { "type": "string", "format": "uri" } }, "useWhen": { "type": "array", "items": { "type": "string" } }, "doNotUseWhen": { "type": "array", "items": { "type": "string" } }, "process": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessStep" } } } }, "ProcessStep": { "type": "object", "title": "ProcessStep", "required": [ "step", "name" ], "properties": { "step": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string" } } }, "Service": { "type": "object", "title": "Service", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "enquiryUrl": { "type": "string", "format": "uri" } } }, "ServiceList": { "type": "object", "title": "ServiceList", "required": [ "total", "count", "items" ], "properties": { "total": { "type": "integer", "description": "Size of the whole collection after filtering." }, "count": { "type": "integer", "description": "Number of items on this page." }, "nextCursor": { "type": [ "string", "null" ], "description": "Pass back as `cursor` to fetch the next page; null on the last page." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Service" } } } }, "Plan": { "type": "object", "title": "Plan", "required": [ "name", "label" ], "properties": { "name": { "type": "string" }, "price": { "type": [ "number", "null" ], "description": "Numeric price parsed from the product page; null when the plan has no printed price." }, "period": { "type": "string" }, "label": { "type": "string", "description": "Price exactly as printed on the product page." } } }, "FaqItem": { "type": "object", "title": "FaqItem", "required": [ "question", "answer" ], "properties": { "question": { "type": "string" }, "answer": { "type": "string" } } }, "Product": { "type": "object", "title": "Product", "required": [ "id", "name", "url", "currency" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "description": { "type": "string" }, "currency": { "type": "string", "examples": [ "PLN" ] }, "priceFrom": { "type": [ "number", "null" ], "description": "Cheapest plan; null when no plan has a printed price." }, "language": { "type": "string" }, "plans": { "type": "array", "items": { "$ref": "#/components/schemas/Plan" } }, "faq": { "type": "array", "items": { "$ref": "#/components/schemas/FaqItem" } } } }, "ProductList": { "type": "object", "title": "ProductList", "required": [ "total", "count", "items" ], "properties": { "total": { "type": "integer", "description": "Size of the whole collection after filtering." }, "count": { "type": "integer", "description": "Number of items on this page." }, "nextCursor": { "type": [ "string", "null" ], "description": "Pass back as `cursor` to fetch the next page; null on the last page." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } } } }, "Resources": { "type": "object", "title": "Resources", "description": "Absolute URLs of the machine-readable resources published by this site.", "properties": { "llmsTxt": { "type": "string", "format": "uri" }, "agentsMd": { "type": "string", "format": "uri" }, "agentCard": { "type": "string", "format": "uri" }, "ard": { "type": "string", "format": "uri" }, "openapi": { "type": "string", "format": "uri" }, "mcpServer": { "type": "string", "format": "uri" }, "mcpManifest": { "type": "string", "format": "uri" }, "developerPortal": { "type": "string", "format": "uri" }, "robotsTxt": { "type": "string", "format": "uri" }, "sitemap": { "type": "string", "format": "uri" } } }, "Job": { "type": "object", "title": "Job", "description": "An asynchronous unit of work. Poll `statusUrl` until `status` reaches a terminal value.", "required": [ "jobId", "type", "status", "statusUrl", "createdAt" ], "properties": { "jobId": { "type": "string", "description": "Identifier to poll with GET /jobs/{id}." }, "type": { "type": "string", "examples": [ "enquiry" ] }, "status": { "type": "string", "enum": [ "queued", "processing", "succeeded", "failed" ], "description": "`succeeded` and `failed` are terminal; stop polling once one of them shows up." }, "statusUrl": { "type": "string", "format": "uri" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "result": { "type": [ "object", "null" ], "description": "Outcome of a succeeded job; null until then.", "properties": { "delivered": { "type": "boolean" }, "replyWithin": { "type": "string" }, "contactUrl": { "type": "string", "format": "uri" } } }, "error": { "type": [ "object", "null" ], "description": "Reason a job failed; null otherwise.", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } }, "EnquiryInput": { "type": "object", "title": "EnquiryInput", "description": "A project enquiry. A useful one states the project type, the platform in use, the deadline and the budget range.", "required": [ "name", "email", "message" ], "properties": { "name": { "type": "string", "minLength": 2, "maxLength": 120 }, "email": { "type": "string", "format": "email" }, "message": { "type": "string", "minLength": 20, "maxLength": 5000 }, "company": { "type": "string", "maxLength": 200 }, "projectType": { "type": "string", "enum": [ "wordpress-prestashop", "web-development", "web-design", "web-efficiency-audits", "ux-reviews", "wcag", "plugin-support", "other" ] }, "budget": { "type": "string", "maxLength": 120 }, "deadline": { "type": "string", "maxLength": 120 }, "language": { "type": "string", "enum": [ "en", "pl" ], "default": "en" }, "sourceUrl": { "type": "string", "format": "uri" }, "website": { "type": "string", "description": "Honeypot. Leave it out or send an empty string; a value here gets the request rejected.", "maxLength": 0 } } }, "Problem": { "type": "object", "title": "Problem", "description": "Error payload following RFC 9457, with the WordPress REST fields kept alongside.", "required": [ "type", "title", "status", "detail", "code", "message" ], "properties": { "type": { "type": "string", "format": "uri", "description": "Stable URI identifying the error type; resolves to its section in the developer portal." }, "title": { "type": "string", "description": "Short, human-readable summary of the error type." }, "status": { "type": "integer", "description": "HTTP status code." }, "detail": { "type": "string", "description": "What went wrong with this particular request." }, "instance": { "type": "string", "description": "The request path that failed." }, "code": { "type": "string", "description": "Machine-readable error code.", "examples": [ "gftw_rate_limited", "gftw_product_not_found", "gftw_invalid_cursor", "rest_no_route", "rest_invalid_param" ] }, "message": { "type": "string", "description": "Same text as `detail`, kept for WordPress REST clients." }, "docs": { "type": "string", "format": "uri" }, "data": { "type": "object", "properties": { "status": { "type": "integer" } } } } } } } }