{ "openapi": "3.1.0", "info": { "title": "Actoki API", "version": "1.1.0", "description": "Machine-readable Actoki API contract generated from the installed service manifests and endpoint request handlers. It includes the documented request options, examples, credit cost metadata and response-field summaries for every public service endpoint.", "termsOfService": "https://actoki.com/", "contact": { "name": "Actoki Support", "url": "https://actoki.com/support", "email": "cs@actoki.com" } }, "servers": [ { "url": "https://actoki.com", "description": "Configured Actoki API server" } ], "externalDocs": { "description": "Actoki developer documentation", "url": "https://actoki.com/docs" }, "tags": [ { "name": "Accessibility Audit API", "description": "Basic accessibility, contrast, heading, forms and alt text checks." }, { "name": "Invoice & Accounting Validation API", "description": "Invoice validation, VAT helpers, payment terms, late fees and credit notes." }, { "name": "Address / Postcode API", "description": "Postcode validation, address formatting, distance and geocode-ready endpoints." }, { "name": "Scheduled Alerts API", "description": "Create and manage scheduled checks with clear delivery and operational status." }, { "name": "Blacklist Monitoring", "description": "One-off and scheduled DNSBL monitoring for domains and sending IPs." }, { "name": "Brand & Marketing Tools API", "description": "Name checks, slug options, domain suggestions and tagline scoring." }, { "name": "Business Enrichment API", "description": "Domain to company profiling, company name cleanup and social link extraction." }, { "name": "Calendar & Business Date API", "description": "Business days, holidays, age, countdown and payday helpers." }, { "name": "Company Registry API", "description": "Search and retrieve official company-register records through a normalised Actoki interface. UK Companies House is production-enabled." }, { "name": "Compliance & GDPR Tools API", "description": "PII scanning, redaction, retention checks and privacy/cookie checks." }, { "name": "Content Safety & Text Intelligence API", "description": "Detect sensitive content, redact common identifiers and add lightweight text intelligence to workflows." }, { "name": "Conversion API", "description": "Unit, temperature, file size, timezone and currency conversions." }, { "name": "Core Utilities", "description": "Password generation, percentage calculations and small utility APIs." }, { "name": "Data Formatter API", "description": "CSV, JSON, XML, YAML and table cleaning utilities." }, { "name": "Data Quality API", "description": "Normalise, compare, deduplicate and improve business data before it reaches downstream systems." }, { "name": "Design Tools API", "description": "Colour palettes, colour conversion, contrast checks and gradients." }, { "name": "Developer Tools API", "description": "UUID, hashes, Base64, JSON, JWT, regex and URL tools." }, { "name": "Document OCR & Extraction API", "description": "Provider-ready document extraction, invoice/receipt helpers and MRZ parsing." }, { "name": "Domain Guard API", "description": "Flags disposable, banned and high-risk domains and email addresses at registration or opt-in time." }, { "name": "Domain Health API", "description": "MXToolbox-style DNS, mail, SPF, DMARC, RDAP and domain health checks using free DNS/RDAP data sources." }, { "name": "Email Verification", "description": "Single and bulk email verification, suppression checks, disposable-domain checks and SMTP risk scoring." }, { "name": "Email Content Tools API", "description": "Email subject scoring, spam words, HTML-to-text and previews." }, { "name": "Email Finder", "description": "Find likely business email addresses using patterns, DNS and optional SMTP evidence." }, { "name": "Finance Calculators API", "description": "Professional finance calculators for interest, mortgage repayments, overpayments, salary estimates and percentage utilities." }, { "name": "Geo Distance & Coordinates API", "description": "Calculate distances, bounding boxes and coordinate relationships for location-aware products." }, { "name": "Government Travel Advice API", "description": "Clean, structured travel advice sourced from official government publications, normalised into plain text for applications and customer journeys." }, { "name": "Identity Document Helper API", "description": "Parse and validate common identity-document formats without exposing permanent credentials to the browser." }, { "name": "Identity and SSO API", "description": "Hosted authentication, passkeys, email passwordless sign-in, social/enterprise federation, OpenID Connect, SAML, Forward Auth, LDAP/Active Directory, super-admin provider availability controls, users, sessions and audit events." }, { "name": "Image Utility API", "description": "Create image placeholders, inspect metadata and derive useful visual properties for application workflows." }, { "name": "Inbox Placement", "description": "Create seed-mailbox placement tests and inspect inbox, spam and authentication results." }, { "name": "Legal Template Helper API", "description": "Template helpers for terms, privacy, cookie and clause libraries. Not legal advice." }, { "name": "Maps API", "description": "PMTiles, MapLibre styles, regional map permissions, short-lived map tokens and map usage reporting." }, { "name": "Notification API", "description": "Prepare and track transactional notifications through controlled server-side workflows." }, { "name": "PDF / Document API", "description": "Provider-ready PDF generation, invoice documents and PDF operations." }, { "name": "Phone Number API", "description": "Validate, format and interpret international phone numbers for cleaner customer data." }, { "name": "Data Privacy Email Scanner API", "description": "Scan emails, support messages and logs for PII, secrets and risky data." }, { "name": "QR Code API", "description": "Generate URL, WiFi, vCard, email, SMS and custom QR payloads." }, { "name": "Fraud & Risk Scoring API", "description": "Combine explainable signals into lightweight risk assessments for sign-up, order and account workflows." }, { "name": "Business Rules / Decision API", "description": "Evaluate straightforward business rules and return explainable decisions for application workflows." }, { "name": "Security Headers & Secret Scanner API", "description": "Security header checks, TLS basics and secret/API key scanning." }, { "name": "SEO Audit API", "description": "SEO page checks, metadata, headings, links, schema, sitemap and robots." }, { "name": "Spam Test", "description": "Mail-tester-style spam checker: send a real email to a one-off test address and get a scored SPF/DKIM/DMARC, blacklist and content report." }, { "name": "CSV & Spreadsheet Quality API", "description": "Spreadsheet profiling, cleaning, column detection, email validation and dedupe." }, { "name": "Text Tools API", "description": "Slugify, case conversion, counts, extraction, de-duplication, diff and lorem ipsum." }, { "name": "Trade Mark Registry API", "description": "Search official trade-mark sources through a consistent interface, with EUIPO search and USPTO known-record support plus safe UK IPO source discovery." }, { "name": "Booking & Travel Rules API", "description": "Travel utility rules for airports, documents, time zones and trip planning." }, { "name": "Travel & Country Utilities API", "description": "Resolve practical airport, country, currency, dial-code and time-zone information for travel applications." }, { "name": "URL Safety & Preview API", "description": "URL preview, redirect, safety and UTM helpers." }, { "name": "Form Validation API", "description": "Validate common form inputs with predictable JSON responses and field-level results." }, { "name": "VAT API", "description": "Example drop-in service for VAT validation and calculations." }, { "name": "Weather & Climate Lookup API", "description": "Current conditions, forecasts, travel windows and climate averages through a configured weather provider." }, { "name": "Webhook Testing & Delivery API", "description": "Plan, test and operate webhook delivery with explicit status, retry and logging contracts." }, { "name": "Website Monitoring API", "description": "HTTP, SSL, DNS, domain expiry and basic page speed checks." } ], "paths": { "/v1/accessibility/page": { "get": { "tags": [ "Accessibility Audit API" ], "summary": "Page accessibility audit", "operationId": "accessibility_audit_get_v1_accessibility_page", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "accessibility_audit", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "alt_text": [], "headings": [], "forms": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/accessibility/page.php", "parameters": [ { "name": "html", "in": "query", "required": true, "description": "HTML document to audit for alternative text, heading structure and form labels. Maximum 200000 characters", "schema": { "type": "string", "example": "

Example

\"\"
", "maxLength": 200000 }, "example": "

Example

\"\"
" } ], "x-actoki-response-fields": [ "alt_text", "headings", "forms" ] }, "post": { "tags": [ "Accessibility Audit API" ], "summary": "Page accessibility audit", "operationId": "accessibility_audit_post_v1_accessibility_page", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "accessibility_audit", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "alt_text": [], "headings": [], "forms": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/accessibility/page.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "html": { "type": "string", "example": "

Example

\"\"
", "maxLength": 200000, "description": "HTML document to audit for alternative text, heading structure and form labels. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "html" ] }, "example": { "html": "

Example

\"\"
" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "html": { "type": "string", "example": "

Example

\"\"
", "maxLength": 200000, "description": "HTML document to audit for alternative text, heading structure and form labels. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "html" ] } } } }, "x-actoki-response-fields": [ "alt_text", "headings", "forms" ] } }, "/v1/accessibility/alt-text": { "get": { "tags": [ "Accessibility Audit API" ], "summary": "Image alt text checker", "operationId": "accessibility_audit_get_v1_accessibility_alt_text", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "accessibility_audit", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "missing_alt_count": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/accessibility/alt-text.php", "parameters": [ { "name": "html", "in": "query", "required": true, "description": "HTML content to process. Maximum 200000 characters", "schema": { "type": "string", "example": "example", "maxLength": 200000 }, "example": "example" } ], "x-actoki-response-fields": [ "missing_alt_count" ] }, "post": { "tags": [ "Accessibility Audit API" ], "summary": "Image alt text checker", "operationId": "accessibility_audit_post_v1_accessibility_alt_text", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "accessibility_audit", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "missing_alt_count": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/accessibility/alt-text.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "html": { "type": "string", "example": "example", "maxLength": 200000, "description": "HTML content to process. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "html" ] }, "example": { "html": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "html": { "type": "string", "example": "example", "maxLength": 200000, "description": "HTML content to process. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "html" ] } } } }, "x-actoki-response-fields": [ "missing_alt_count" ] } }, "/v1/accessibility/headings": { "get": { "tags": [ "Accessibility Audit API" ], "summary": "Heading order checker", "operationId": "accessibility_audit_get_v1_accessibility_headings", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "accessibility_audit", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "headings": [], "has_h1": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/accessibility/headings.php", "parameters": [ { "name": "html", "in": "query", "required": true, "description": "HTML content to process. Maximum 200000 characters", "schema": { "type": "string", "example": "example", "maxLength": 200000 }, "example": "example" } ], "x-actoki-response-fields": [ "headings", "has_h1" ] }, "post": { "tags": [ "Accessibility Audit API" ], "summary": "Heading order checker", "operationId": "accessibility_audit_post_v1_accessibility_headings", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "accessibility_audit", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "headings": [], "has_h1": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/accessibility/headings.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "html": { "type": "string", "example": "example", "maxLength": 200000, "description": "HTML content to process. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "html" ] }, "example": { "html": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "html": { "type": "string", "example": "example", "maxLength": 200000, "description": "HTML content to process. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "html" ] } } } }, "x-actoki-response-fields": [ "headings", "has_h1" ] } }, "/v1/accessibility/forms": { "get": { "tags": [ "Accessibility Audit API" ], "summary": "Form label checker", "operationId": "accessibility_audit_get_v1_accessibility_forms", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "accessibility_audit", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "input_count": [], "label_count": [], "likely_missing_labels": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/accessibility/forms.php", "parameters": [ { "name": "html", "in": "query", "required": true, "description": "HTML content to process. Maximum 200000 characters", "schema": { "type": "string", "example": "example", "maxLength": 200000 }, "example": "example" } ], "x-actoki-response-fields": [ "input_count", "label_count", "likely_missing_labels" ] }, "post": { "tags": [ "Accessibility Audit API" ], "summary": "Form label checker", "operationId": "accessibility_audit_post_v1_accessibility_forms", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "accessibility_audit", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "input_count": [], "label_count": [], "likely_missing_labels": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/accessibility/forms.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "html": { "type": "string", "example": "example", "maxLength": 200000, "description": "HTML content to process. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "html" ] }, "example": { "html": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "html": { "type": "string", "example": "example", "maxLength": 200000, "description": "HTML content to process. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "html" ] } } } }, "x-actoki-response-fields": [ "input_count", "label_count", "likely_missing_labels" ] } }, "/v1/accounting/invoice-validate": { "get": { "tags": [ "Invoice & Accounting Validation API" ], "summary": "Invoice validation", "operationId": "accounting_tools_get_v1_accounting_invoice_validate", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "accounting_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": [], "missing": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/accounting/invoice-validate.php", "parameters": [ { "name": "invoice_number", "in": "query", "required": true, "description": "Invoice reference or number.", "schema": { "type": "string", "example": "INV-2026-001" }, "example": "INV-2026-001" }, { "name": "date", "in": "query", "required": true, "description": "Invoice issue date.", "schema": { "type": "string", "example": "2026-08-03" }, "example": "2026-08-03" }, { "name": "seller", "in": "query", "required": true, "description": "Seller or supplier name.", "schema": { "type": "string", "example": "Example Supplier Ltd" }, "example": "Example Supplier Ltd" }, { "name": "buyer", "in": "query", "required": true, "description": "Buyer or customer name.", "schema": { "type": "string", "example": "Example Customer Ltd" }, "example": "Example Customer Ltd" }, { "name": "amount", "in": "query", "required": true, "description": "Invoice total amount.", "schema": { "type": "number", "example": "1250.00" }, "example": "1250.00" } ], "x-actoki-response-fields": [ "valid", "missing" ] }, "post": { "tags": [ "Invoice & Accounting Validation API" ], "summary": "Invoice validation", "operationId": "accounting_tools_post_v1_accounting_invoice_validate", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "accounting_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": [], "missing": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/accounting/invoice-validate.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "invoice_number": { "type": "string", "example": "INV-2026-001", "description": "Invoice reference or number." }, "date": { "type": "string", "example": "2026-08-03", "description": "Invoice issue date." }, "seller": { "type": "string", "example": "Example Supplier Ltd", "description": "Seller or supplier name." }, "buyer": { "type": "string", "example": "Example Customer Ltd", "description": "Buyer or customer name." }, "amount": { "type": "number", "example": "1250.00", "description": "Invoice total amount." } }, "additionalProperties": false, "required": [ "invoice_number", "date", "seller", "buyer", "amount" ] }, "example": { "invoice_number": "INV-2026-001", "date": "2026-08-03", "seller": "Example Supplier Ltd", "buyer": "Example Customer Ltd", "amount": "1250.00" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "invoice_number": { "type": "string", "example": "INV-2026-001", "description": "Invoice reference or number." }, "date": { "type": "string", "example": "2026-08-03", "description": "Invoice issue date." }, "seller": { "type": "string", "example": "Example Supplier Ltd", "description": "Seller or supplier name." }, "buyer": { "type": "string", "example": "Example Customer Ltd", "description": "Buyer or customer name." }, "amount": { "type": "number", "example": "1250.00", "description": "Invoice total amount." } }, "additionalProperties": false, "required": [ "invoice_number", "date", "seller", "buyer", "amount" ] } } } }, "x-actoki-response-fields": [ "valid", "missing" ] } }, "/v1/accounting/vat-calculate": { "get": { "tags": [ "Invoice & Accounting Validation API" ], "summary": "VAT calculator", "operationId": "accounting_tools_get_v1_accounting_vat_calculate", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "accounting_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "net": [], "vat_rate": [], "vat": [], "gross": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/accounting/vat-calculate.php", "parameters": [ { "name": "amount", "in": "query", "required": false, "description": "Request option: Amount. Default: 100", "schema": { "type": "number", "default": 100, "example": 100 }, "example": 100 }, { "name": "rate", "in": "query", "required": false, "description": "Request option: Rate. Default: 20", "schema": { "type": "number", "default": 20, "example": 20 }, "example": 20 } ], "x-actoki-response-fields": [ "net", "vat_rate", "vat", "gross" ] }, "post": { "tags": [ "Invoice & Accounting Validation API" ], "summary": "VAT calculator", "operationId": "accounting_tools_post_v1_accounting_vat_calculate", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "accounting_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "net": [], "vat_rate": [], "vat": [], "gross": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/accounting/vat-calculate.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "number", "default": 100, "example": 100, "description": "Request option: Amount. Default: 100" }, "rate": { "type": "number", "default": 20, "example": 20, "description": "Request option: Rate. Default: 20" } }, "additionalProperties": false }, "example": { "amount": 100, "rate": 20 } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "amount": { "type": "number", "default": 100, "example": 100, "description": "Request option: Amount. Default: 100" }, "rate": { "type": "number", "default": 20, "example": 20, "description": "Request option: Rate. Default: 20" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "net", "vat_rate", "vat", "gross" ] } }, "/v1/accounting/vat-number-format": { "get": { "tags": [ "Invoice & Accounting Validation API" ], "summary": "VAT number format check", "operationId": "accounting_tools_get_v1_accounting_vat_number_format", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "accounting_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/accounting/vat-number-format.php", "parameters": [ { "name": "vat", "in": "query", "required": true, "description": "VAT registration number including country prefix where applicable. Maximum 30 characters", "schema": { "type": "string", "example": "GB123456789", "maxLength": 30 }, "example": "GB123456789" } ] }, "post": { "tags": [ "Invoice & Accounting Validation API" ], "summary": "VAT number format check", "operationId": "accounting_tools_post_v1_accounting_vat_number_format", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "accounting_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/accounting/vat-number-format.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "vat": { "type": "string", "example": "GB123456789", "maxLength": 30, "description": "VAT registration number including country prefix where applicable. Maximum 30 characters" } }, "additionalProperties": false, "required": [ "vat" ] }, "example": { "vat": "GB123456789" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "vat": { "type": "string", "example": "GB123456789", "maxLength": 30, "description": "VAT registration number including country prefix where applicable. Maximum 30 characters" } }, "additionalProperties": false, "required": [ "vat" ] } } } } } }, "/v1/accounting/payment-terms": { "get": { "tags": [ "Invoice & Accounting Validation API" ], "summary": "Payment due date calculator", "operationId": "accounting_tools_get_v1_accounting_payment_terms", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "accounting_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "due_date": [], "terms_days": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/accounting/payment-terms.php", "parameters": [ { "name": "invoice_date", "in": "query", "required": false, "description": "Request option: Invoice Date. Default: now", "schema": { "type": "string", "default": "now", "example": "now" }, "example": "now" }, { "name": "days", "in": "query", "required": false, "description": "Request option: Days. Default: 30 · Min: 0 · Max: 365", "schema": { "type": "integer", "default": 30, "example": 30, "minimum": 0, "maximum": 365 }, "example": 30 } ], "x-actoki-response-fields": [ "due_date", "terms_days" ] }, "post": { "tags": [ "Invoice & Accounting Validation API" ], "summary": "Payment due date calculator", "operationId": "accounting_tools_post_v1_accounting_payment_terms", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "accounting_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "due_date": [], "terms_days": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/accounting/payment-terms.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "invoice_date": { "type": "string", "default": "now", "example": "now", "description": "Request option: Invoice Date. Default: now" }, "days": { "type": "integer", "default": 30, "example": 30, "minimum": 0, "maximum": 365, "description": "Request option: Days. Default: 30 · Min: 0 · Max: 365" } }, "additionalProperties": false }, "example": { "invoice_date": "now", "days": 30 } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "invoice_date": { "type": "string", "default": "now", "example": "now", "description": "Request option: Invoice Date. Default: now" }, "days": { "type": "integer", "default": 30, "example": 30, "minimum": 0, "maximum": 365, "description": "Request option: Days. Default: 30 · Min: 0 · Max: 365" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "due_date", "terms_days" ] } }, "/v1/accounting/late-fee": { "get": { "tags": [ "Invoice & Accounting Validation API" ], "summary": "Late fee calculator", "operationId": "accounting_tools_get_v1_accounting_late_fee", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "accounting_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "interest": [], "days_late": [], "annual_rate": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/accounting/late-fee.php", "parameters": [ { "name": "days", "in": "query", "required": false, "description": "Request option: Days. Default: 30 · Min: 0 · Max: 365", "schema": { "type": "integer", "default": 30, "example": 30, "minimum": 0, "maximum": 365 }, "example": 30 }, { "name": "rate", "in": "query", "required": false, "description": "Request option: Rate. Default: 20", "schema": { "type": "number", "default": 20, "example": 20 }, "example": 20 }, { "name": "amount", "in": "query", "required": false, "description": "Request option: Amount. Default: 100", "schema": { "type": "number", "default": 100, "example": 100 }, "example": 100 }, { "name": "annual_rate", "in": "query", "required": false, "description": "Request option: Annual Rate. Default: 8", "schema": { "type": "number", "default": 8, "example": 8 }, "example": 8 }, { "name": "days_late", "in": "query", "required": false, "description": "Request option: Days Late. Default: 30 · Min: 0 · Max: 3650", "schema": { "type": "integer", "default": 30, "example": 30, "minimum": 0, "maximum": 3650 }, "example": 30 } ], "x-actoki-response-fields": [ "interest", "days_late", "annual_rate" ] }, "post": { "tags": [ "Invoice & Accounting Validation API" ], "summary": "Late fee calculator", "operationId": "accounting_tools_post_v1_accounting_late_fee", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "accounting_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "interest": [], "days_late": [], "annual_rate": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/accounting/late-fee.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "days": { "type": "integer", "default": 30, "example": 30, "minimum": 0, "maximum": 365, "description": "Request option: Days. Default: 30 · Min: 0 · Max: 365" }, "rate": { "type": "number", "default": 20, "example": 20, "description": "Request option: Rate. Default: 20" }, "amount": { "type": "number", "default": 100, "example": 100, "description": "Request option: Amount. Default: 100" }, "annual_rate": { "type": "number", "default": 8, "example": 8, "description": "Request option: Annual Rate. Default: 8" }, "days_late": { "type": "integer", "default": 30, "example": 30, "minimum": 0, "maximum": 3650, "description": "Request option: Days Late. Default: 30 · Min: 0 · Max: 3650" } }, "additionalProperties": false }, "example": { "days": 30, "rate": 20, "amount": 100 } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "days": { "type": "integer", "default": 30, "example": 30, "minimum": 0, "maximum": 365, "description": "Request option: Days. Default: 30 · Min: 0 · Max: 365" }, "rate": { "type": "number", "default": 20, "example": 20, "description": "Request option: Rate. Default: 20" }, "amount": { "type": "number", "default": 100, "example": 100, "description": "Request option: Amount. Default: 100" }, "annual_rate": { "type": "number", "default": 8, "example": 8, "description": "Request option: Annual Rate. Default: 8" }, "days_late": { "type": "integer", "default": 30, "example": 30, "minimum": 0, "maximum": 3650, "description": "Request option: Days Late. Default: 30 · Min: 0 · Max: 3650" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "interest", "days_late", "annual_rate" ] } }, "/v1/accounting/credit-note": { "get": { "tags": [ "Invoice & Accounting Validation API" ], "summary": "Credit note helper", "operationId": "accounting_tools_get_v1_accounting_credit_note", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "accounting_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "credit_note_number": [], "amount": [], "status": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/accounting/credit-note.php", "parameters": [ { "name": "amount", "in": "query", "required": false, "description": "Request option: Amount. Default: 1000", "schema": { "type": "number", "default": 1000, "example": 1000 }, "example": 1000 } ], "x-actoki-response-fields": [ "credit_note_number", "amount", "status" ] }, "post": { "tags": [ "Invoice & Accounting Validation API" ], "summary": "Credit note helper", "operationId": "accounting_tools_post_v1_accounting_credit_note", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "accounting_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "credit_note_number": [], "amount": [], "status": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/accounting/credit-note.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "number", "default": 1000, "example": 1000, "description": "Request option: Amount. Default: 1000" } }, "additionalProperties": false }, "example": { "amount": 1000 } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "amount": { "type": "number", "default": 1000, "example": 1000, "description": "Request option: Amount. Default: 1000" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "credit_note_number", "amount", "status" ] } }, "/v1/address/postcode": { "get": { "tags": [ "Address / Postcode API" ], "summary": "Validate UK postcode.", "operationId": "address_tools_get_v1_address_postcode", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "address_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "postcode": [], "valid": [], "formatted": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/address/postcode.php", "parameters": [ { "name": "postcode", "in": "query", "required": false, "description": "Request option: Postcode. Default: · Maximum 20 characters", "schema": { "type": "string", "default": "", "example": "example", "maxLength": 20 }, "example": "example" } ], "x-actoki-response-fields": [ "postcode", "valid", "formatted" ] }, "post": { "tags": [ "Address / Postcode API" ], "summary": "Validate UK postcode.", "operationId": "address_tools_post_v1_address_postcode", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "address_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "postcode": [], "valid": [], "formatted": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/address/postcode.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "postcode": { "type": "string", "default": "", "example": "example", "maxLength": 20, "description": "Request option: Postcode. Default: · Maximum 20 characters" } }, "additionalProperties": false }, "example": { "postcode": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "postcode": { "type": "string", "default": "", "example": "example", "maxLength": 20, "description": "Request option: Postcode. Default: · Maximum 20 characters" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "postcode", "valid", "formatted" ] } }, "/v1/address/distance": { "get": { "tags": [ "Address / Postcode API" ], "summary": "Distance between coordinates.", "operationId": "address_tools_get_v1_address_distance", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "address_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "kilometres": [], "miles": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/address/distance.php", "parameters": [ { "name": "lat1", "in": "query", "required": false, "description": "Request option: Lat1. Default: 0", "schema": { "type": "number", "default": 0, "example": 0 }, "example": 0 }, { "name": "lon1", "in": "query", "required": false, "description": "Request option: Lon1. Default: 0", "schema": { "type": "number", "default": 0, "example": 0 }, "example": 0 }, { "name": "lat2", "in": "query", "required": false, "description": "Request option: Lat2. Default: 0", "schema": { "type": "number", "default": 0, "example": 0 }, "example": 0 }, { "name": "lon2", "in": "query", "required": false, "description": "Request option: Lon2. Default: 0", "schema": { "type": "number", "default": 0, "example": 0 }, "example": 0 } ], "x-actoki-response-fields": [ "kilometres", "miles" ] }, "post": { "tags": [ "Address / Postcode API" ], "summary": "Distance between coordinates.", "operationId": "address_tools_post_v1_address_distance", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "address_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "kilometres": [], "miles": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/address/distance.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "lat1": { "type": "number", "default": 0, "example": 0, "description": "Request option: Lat1. Default: 0" }, "lon1": { "type": "number", "default": 0, "example": 0, "description": "Request option: Lon1. Default: 0" }, "lat2": { "type": "number", "default": 0, "example": 0, "description": "Request option: Lat2. Default: 0" }, "lon2": { "type": "number", "default": 0, "example": 0, "description": "Request option: Lon2. Default: 0" } }, "additionalProperties": false }, "example": { "lat1": 0, "lon1": 0, "lat2": 0 } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "lat1": { "type": "number", "default": 0, "example": 0, "description": "Request option: Lat1. Default: 0" }, "lon1": { "type": "number", "default": 0, "example": 0, "description": "Request option: Lon1. Default: 0" }, "lat2": { "type": "number", "default": 0, "example": 0, "description": "Request option: Lat2. Default: 0" }, "lon2": { "type": "number", "default": 0, "example": 0, "description": "Request option: Lon2. Default: 0" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "kilometres", "miles" ] } }, "/v1/blacklist/check": { "post": { "tags": [ "Blacklist Monitoring" ], "summary": "Check a domain or IPv4 address against configured DNSBLs.", "operationId": "blacklist_monitoring_post_v1_blacklist_check", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "blacklist_monitoring", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/blacklist/check.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "default": "domain", "example": "domain", "description": "Request option: Type. Default: domain" }, "target": { "type": "string", "default": "", "example": "example", "description": "Request option: Target. Default:" } }, "additionalProperties": false }, "example": { "type": "domain", "target": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "type": { "type": "string", "default": "domain", "example": "domain", "description": "Request option: Type. Default: domain" }, "target": { "type": "string", "default": "", "example": "example", "description": "Request option: Target. Default:" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "result" ] } }, "/v1/blacklist/monitors": { "get": { "tags": [ "Blacklist Monitoring" ], "summary": "Create, list or delete blacklist monitors.", "operationId": "blacklist_monitoring_get_v1_blacklist_monitors", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "blacklist_monitoring", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": [], "id": [], "monitors": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/blacklist/monitors.php", "parameters": [ { "name": "id", "in": "query", "required": false, "description": "Request option: Id.", "schema": { "type": "string", "example": "example" }, "example": "example" }, { "name": "type", "in": "query", "required": false, "description": "Request option: Type. Default: domain", "schema": { "type": "string", "default": "domain", "example": "domain" }, "example": "domain" }, { "name": "target", "in": "query", "required": false, "description": "Request option: Target. Default:", "schema": { "type": "string", "default": "", "example": "example" }, "example": "example" }, { "name": "label", "in": "query", "required": false, "description": "Request option: Label. Default:", "schema": { "type": "string", "default": "", "example": "example" }, "example": "example" }, { "name": "alert_email", "in": "query", "required": false, "description": "Request option: Alert Email. Default:", "schema": { "type": "string", "default": "", "example": "user@example.com" }, "example": "user@example.com" } ], "x-actoki-response-fields": [ "error", "id", "monitors" ] }, "post": { "tags": [ "Blacklist Monitoring" ], "summary": "Create, list or delete blacklist monitors.", "operationId": "blacklist_monitoring_post_v1_blacklist_monitors", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "blacklist_monitoring", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": [], "id": [], "monitors": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/blacklist/monitors.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "example", "description": "Request option: Id." }, "type": { "type": "string", "default": "domain", "example": "domain", "description": "Request option: Type. Default: domain" }, "target": { "type": "string", "default": "", "example": "example", "description": "Request option: Target. Default:" }, "label": { "type": "string", "default": "", "example": "example", "description": "Request option: Label. Default:" }, "alert_email": { "type": "string", "default": "", "example": "user@example.com", "description": "Request option: Alert Email. Default:" } }, "additionalProperties": false }, "example": { "id": "example", "type": "domain", "target": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "example", "description": "Request option: Id." }, "type": { "type": "string", "default": "domain", "example": "domain", "description": "Request option: Type. Default: domain" }, "target": { "type": "string", "default": "", "example": "example", "description": "Request option: Target. Default:" }, "label": { "type": "string", "default": "", "example": "example", "description": "Request option: Label. Default:" }, "alert_email": { "type": "string", "default": "", "example": "user@example.com", "description": "Request option: Alert Email. Default:" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "error", "id", "monitors" ] }, "delete": { "tags": [ "Blacklist Monitoring" ], "summary": "Create, list or delete blacklist monitors.", "operationId": "blacklist_monitoring_delete_v1_blacklist_monitors", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "blacklist_monitoring", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": [], "id": [], "monitors": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/blacklist/monitors.php", "parameters": [ { "name": "id", "in": "query", "required": false, "description": "Request option: Id.", "schema": { "type": "string", "example": "example" }, "example": "example" }, { "name": "type", "in": "query", "required": false, "description": "Request option: Type. Default: domain", "schema": { "type": "string", "default": "domain", "example": "domain" }, "example": "domain" }, { "name": "target", "in": "query", "required": false, "description": "Request option: Target. Default:", "schema": { "type": "string", "default": "", "example": "example" }, "example": "example" }, { "name": "label", "in": "query", "required": false, "description": "Request option: Label. Default:", "schema": { "type": "string", "default": "", "example": "example" }, "example": "example" }, { "name": "alert_email", "in": "query", "required": false, "description": "Request option: Alert Email. Default:", "schema": { "type": "string", "default": "", "example": "user@example.com" }, "example": "user@example.com" } ], "x-actoki-response-fields": [ "error", "id", "monitors" ] } }, "/v1/brand/name-check": { "get": { "tags": [ "Brand & Marketing Tools API" ], "summary": "Brand name check", "operationId": "brand_marketing_get_v1_brand_name_check", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "brand_marketing", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": [], "slug": [], "length_ok": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/brand/name-check.php", "parameters": [ { "name": "name", "in": "query", "required": true, "description": "Human-readable name.", "schema": { "type": "string", "example": "example" }, "example": "example" } ], "x-actoki-response-fields": [ "name", "slug", "length_ok" ] }, "post": { "tags": [ "Brand & Marketing Tools API" ], "summary": "Brand name check", "operationId": "brand_marketing_post_v1_brand_name_check", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "brand_marketing", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": [], "slug": [], "length_ok": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/brand/name-check.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "example", "description": "Human-readable name." } }, "additionalProperties": false, "required": [ "name" ] }, "example": { "name": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "example", "description": "Human-readable name." } }, "additionalProperties": false, "required": [ "name" ] } } } }, "x-actoki-response-fields": [ "name", "slug", "length_ok" ] } }, "/v1/brand/slug-options": { "get": { "tags": [ "Brand & Marketing Tools API" ], "summary": "Slug options", "operationId": "brand_marketing_get_v1_brand_slug_options", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "brand_marketing", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "slugs": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/brand/slug-options.php", "parameters": [ { "name": "name", "in": "query", "required": true, "description": "Human-readable name.", "schema": { "type": "string", "example": "example" }, "example": "example" } ], "x-actoki-response-fields": [ "slugs" ] }, "post": { "tags": [ "Brand & Marketing Tools API" ], "summary": "Slug options", "operationId": "brand_marketing_post_v1_brand_slug_options", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "brand_marketing", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "slugs": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/brand/slug-options.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "example", "description": "Human-readable name." } }, "additionalProperties": false, "required": [ "name" ] }, "example": { "name": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "example", "description": "Human-readable name." } }, "additionalProperties": false, "required": [ "name" ] } } } }, "x-actoki-response-fields": [ "slugs" ] } }, "/v1/brand/domain-suggestions": { "get": { "tags": [ "Brand & Marketing Tools API" ], "summary": "Domain suggestions", "operationId": "brand_marketing_get_v1_brand_domain_suggestions", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "brand_marketing", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "domains": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/brand/domain-suggestions.php", "parameters": [ { "name": "name", "in": "query", "required": true, "description": "Human-readable name.", "schema": { "type": "string", "example": "example" }, "example": "example" } ], "x-actoki-response-fields": [ "domains" ] }, "post": { "tags": [ "Brand & Marketing Tools API" ], "summary": "Domain suggestions", "operationId": "brand_marketing_post_v1_brand_domain_suggestions", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "brand_marketing", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "domains": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/brand/domain-suggestions.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "example", "description": "Human-readable name." } }, "additionalProperties": false, "required": [ "name" ] }, "example": { "name": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "example", "description": "Human-readable name." } }, "additionalProperties": false, "required": [ "name" ] } } } }, "x-actoki-response-fields": [ "domains" ] } }, "/v1/brand/tagline-score": { "get": { "tags": [ "Brand & Marketing Tools API" ], "summary": "Tagline score", "operationId": "brand_marketing_get_v1_brand_tagline_score", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "brand_marketing", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "length": [], "score": [], "note": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/brand/tagline-score.php", "parameters": [ { "name": "tagline", "in": "query", "required": true, "description": "Request option: Tagline.", "schema": { "type": "string", "example": "example" }, "example": "example" } ], "x-actoki-response-fields": [ "length", "score", "note" ] }, "post": { "tags": [ "Brand & Marketing Tools API" ], "summary": "Tagline score", "operationId": "brand_marketing_post_v1_brand_tagline_score", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "brand_marketing", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "length": [], "score": [], "note": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/brand/tagline-score.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "tagline": { "type": "string", "example": "example", "description": "Request option: Tagline." } }, "additionalProperties": false, "required": [ "tagline" ] }, "example": { "tagline": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "tagline": { "type": "string", "example": "example", "description": "Request option: Tagline." } }, "additionalProperties": false, "required": [ "tagline" ] } } } }, "x-actoki-response-fields": [ "length", "score", "note" ] } }, "/v1/brand/social-handle-format": { "get": { "tags": [ "Brand & Marketing Tools API" ], "summary": "Social handle formatter", "operationId": "brand_marketing_get_v1_brand_social_handle_format", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "brand_marketing", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "handle": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/brand/social-handle-format.php", "parameters": [ { "name": "name", "in": "query", "required": true, "description": "Human-readable name.", "schema": { "type": "string", "example": "example" }, "example": "example" } ], "x-actoki-response-fields": [ "handle" ] }, "post": { "tags": [ "Brand & Marketing Tools API" ], "summary": "Social handle formatter", "operationId": "brand_marketing_post_v1_brand_social_handle_format", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "brand_marketing", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "handle": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/brand/social-handle-format.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "example", "description": "Human-readable name." } }, "additionalProperties": false, "required": [ "name" ] }, "example": { "name": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "example", "description": "Human-readable name." } }, "additionalProperties": false, "required": [ "name" ] } } } }, "x-actoki-response-fields": [ "handle" ] } }, "/v1/business/website-profile": { "get": { "tags": [ "Business Enrichment API" ], "summary": "Website profile", "operationId": "business_enrichment_get_v1_business_website_profile", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "business_enrichment", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": [], "dns": [], "a": [], "company_guess": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/business/website-profile.php", "parameters": [ { "name": "domain", "in": "query", "required": true, "description": "Domain name without a path.", "schema": { "type": "string", "example": "example.com" }, "example": "example.com" } ], "x-actoki-response-fields": [ "domain", "dns", "a", "company_guess" ] }, "post": { "tags": [ "Business Enrichment API" ], "summary": "Website profile", "operationId": "business_enrichment_post_v1_business_website_profile", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "business_enrichment", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": [], "dns": [], "a": [], "company_guess": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/business/website-profile.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "example": "example.com", "description": "Domain name without a path." } }, "additionalProperties": false, "required": [ "domain" ] }, "example": { "domain": "example.com" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "example": "example.com", "description": "Domain name without a path." } }, "additionalProperties": false, "required": [ "domain" ] } } } }, "x-actoki-response-fields": [ "domain", "dns", "a", "company_guess" ] } }, "/v1/business/domain-to-company": { "get": { "tags": [ "Business Enrichment API" ], "summary": "Infer company from domain", "operationId": "business_enrichment_get_v1_business_domain_to_company", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "business_enrichment", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": [], "company_guess": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/business/domain-to-company.php", "parameters": [ { "name": "domain", "in": "query", "required": true, "description": "Domain name without a path.", "schema": { "type": "string", "example": "example.com" }, "example": "example.com" } ], "x-actoki-response-fields": [ "domain", "company_guess" ] }, "post": { "tags": [ "Business Enrichment API" ], "summary": "Infer company from domain", "operationId": "business_enrichment_post_v1_business_domain_to_company", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "business_enrichment", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": [], "company_guess": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/business/domain-to-company.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "example": "example.com", "description": "Domain name without a path." } }, "additionalProperties": false, "required": [ "domain" ] }, "example": { "domain": "example.com" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "example": "example.com", "description": "Domain name without a path." } }, "additionalProperties": false, "required": [ "domain" ] } } } }, "x-actoki-response-fields": [ "domain", "company_guess" ] } }, "/v1/business/company-clean-name": { "get": { "tags": [ "Business Enrichment API" ], "summary": "Clean company name", "operationId": "business_enrichment_get_v1_business_company_clean_name", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "business_enrichment", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/business/company-clean-name.php", "parameters": [ { "name": "name", "in": "query", "required": true, "description": "Company name to normalise by removing common legal suffixes. Maximum 5000 characters", "schema": { "type": "string", "example": "Example Travel Limited", "maxLength": 5000 }, "example": "Example Travel Limited" } ] }, "post": { "tags": [ "Business Enrichment API" ], "summary": "Clean company name", "operationId": "business_enrichment_post_v1_business_company_clean_name", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "business_enrichment", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/business/company-clean-name.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Example Travel Limited", "maxLength": 5000, "description": "Company name to normalise by removing common legal suffixes. Maximum 5000 characters" } }, "additionalProperties": false, "required": [ "name" ] }, "example": { "name": "Example Travel Limited" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Example Travel Limited", "maxLength": 5000, "description": "Company name to normalise by removing common legal suffixes. Maximum 5000 characters" } }, "additionalProperties": false, "required": [ "name" ] } } } } } }, "/v1/business/email-domain-profile": { "get": { "tags": [ "Business Enrichment API" ], "summary": "Email domain profile", "operationId": "business_enrichment_get_v1_business_email_domain_profile", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "business_enrichment", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": [], "has_mx": [], "has_website": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/business/email-domain-profile.php", "parameters": [ { "name": "domain", "in": "query", "required": true, "description": "Domain name without a path.", "schema": { "type": "string", "example": "example.com" }, "example": "example.com" } ], "x-actoki-response-fields": [ "domain", "has_mx", "has_website" ] }, "post": { "tags": [ "Business Enrichment API" ], "summary": "Email domain profile", "operationId": "business_enrichment_post_v1_business_email_domain_profile", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "business_enrichment", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": [], "has_mx": [], "has_website": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/business/email-domain-profile.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "example": "example.com", "description": "Domain name without a path." } }, "additionalProperties": false, "required": [ "domain" ] }, "example": { "domain": "example.com" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "example": "example.com", "description": "Domain name without a path." } }, "additionalProperties": false, "required": [ "domain" ] } } } }, "x-actoki-response-fields": [ "domain", "has_mx", "has_website" ] } }, "/v1/business/social-links": { "get": { "tags": [ "Business Enrichment API" ], "summary": "Extract social links from HTML", "operationId": "business_enrichment_get_v1_business_social_links", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "business_enrichment", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "links": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/business/social-links.php", "parameters": [ { "name": "html", "in": "query", "required": true, "description": "HTML content to process. Maximum 200000 characters", "schema": { "type": "string", "example": "example", "maxLength": 200000 }, "example": "example" } ], "x-actoki-response-fields": [ "links" ] }, "post": { "tags": [ "Business Enrichment API" ], "summary": "Extract social links from HTML", "operationId": "business_enrichment_post_v1_business_social_links", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "business_enrichment", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "links": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/business/social-links.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "html": { "type": "string", "example": "example", "maxLength": 200000, "description": "HTML content to process. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "html" ] }, "example": { "html": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "html": { "type": "string", "example": "example", "maxLength": 200000, "description": "HTML content to process. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "html" ] } } } }, "x-actoki-response-fields": [ "links" ] } }, "/v1/date/business-days": { "get": { "tags": [ "Calendar & Business Date API" ], "summary": "Business days between dates", "operationId": "calendar_date_get_v1_date_business_days", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "calendar_date", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "business_days": [], "start": [], "end": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/date/business-days.php", "parameters": [ { "name": "end", "in": "query", "required": false, "description": "Request option: End. Default: +30 days", "schema": { "type": "string", "default": "+30 days", "example": "+30 days" }, "example": "+30 days" }, { "name": "start", "in": "query", "required": false, "description": "Request option: Start. Default: today", "schema": { "type": "string", "default": "today", "example": "today" }, "example": "today" } ], "x-actoki-response-fields": [ "business_days", "start", "end" ] }, "post": { "tags": [ "Calendar & Business Date API" ], "summary": "Business days between dates", "operationId": "calendar_date_post_v1_date_business_days", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "calendar_date", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "business_days": [], "start": [], "end": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/date/business-days.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "end": { "type": "string", "default": "+30 days", "example": "+30 days", "description": "Request option: End. Default: +30 days" }, "start": { "type": "string", "default": "today", "example": "today", "description": "Request option: Start. Default: today" } }, "additionalProperties": false }, "example": { "end": "+30 days", "start": "today" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "end": { "type": "string", "default": "+30 days", "example": "+30 days", "description": "Request option: End. Default: +30 days" }, "start": { "type": "string", "default": "today", "example": "today", "description": "Request option: Start. Default: today" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "business_days", "start", "end" ] } }, "/v1/date/add-business-days": { "get": { "tags": [ "Calendar & Business Date API" ], "summary": "Add business days", "operationId": "calendar_date_get_v1_date_add_business_days", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "calendar_date", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "date": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/date/add-business-days.php", "parameters": [ { "name": "start", "in": "query", "required": false, "description": "Request option: Start. Default: today", "schema": { "type": "string", "default": "today", "example": "today" }, "example": "today" }, { "name": "days", "in": "query", "required": false, "description": "Request option: Days. Default: 5", "schema": { "type": "integer", "default": 5, "example": 5 }, "example": 5 } ], "x-actoki-response-fields": [ "date" ] }, "post": { "tags": [ "Calendar & Business Date API" ], "summary": "Add business days", "operationId": "calendar_date_post_v1_date_add_business_days", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "calendar_date", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "date": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/date/add-business-days.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "start": { "type": "string", "default": "today", "example": "today", "description": "Request option: Start. Default: today" }, "days": { "type": "integer", "default": 5, "example": 5, "description": "Request option: Days. Default: 5" } }, "additionalProperties": false }, "example": { "start": "today", "days": 5 } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "start": { "type": "string", "default": "today", "example": "today", "description": "Request option: Start. Default: today" }, "days": { "type": "integer", "default": 5, "example": 5, "description": "Request option: Days. Default: 5" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "date" ] } }, "/v1/date/working-days-between": { "get": { "tags": [ "Calendar & Business Date API" ], "summary": "Working days between dates", "operationId": "calendar_date_get_v1_date_working_days_between", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "calendar_date", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "business_days": [], "start": [], "end": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/date/working-days-between.php", "parameters": [ { "name": "end", "in": "query", "required": false, "description": "Request option: End. Default: +30 days", "schema": { "type": "string", "default": "+30 days", "example": "+30 days" }, "example": "+30 days" }, { "name": "start", "in": "query", "required": false, "description": "Request option: Start. Default: today", "schema": { "type": "string", "default": "today", "example": "today" }, "example": "today" } ], "x-actoki-response-fields": [ "business_days", "start", "end" ] }, "post": { "tags": [ "Calendar & Business Date API" ], "summary": "Working days between dates", "operationId": "calendar_date_post_v1_date_working_days_between", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "calendar_date", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "business_days": [], "start": [], "end": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/date/working-days-between.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "end": { "type": "string", "default": "+30 days", "example": "+30 days", "description": "Request option: End. Default: +30 days" }, "start": { "type": "string", "default": "today", "example": "today", "description": "Request option: Start. Default: today" } }, "additionalProperties": false }, "example": { "end": "+30 days", "start": "today" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "end": { "type": "string", "default": "+30 days", "example": "+30 days", "description": "Request option: End. Default: +30 days" }, "start": { "type": "string", "default": "today", "example": "today", "description": "Request option: Start. Default: today" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "business_days", "start", "end" ] } }, "/v1/date/age": { "get": { "tags": [ "Calendar & Business Date API" ], "summary": "Age calculator", "operationId": "calendar_date_get_v1_date_age", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "calendar_date", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "age_years": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/date/age.php", "parameters": [ { "name": "dob", "in": "query", "required": false, "description": "Request option: Dob. Default: 2000-01-01", "schema": { "type": "string", "default": "2000-01-01", "example": "2000-01-01" }, "example": "2000-01-01" } ], "x-actoki-response-fields": [ "age_years" ] }, "post": { "tags": [ "Calendar & Business Date API" ], "summary": "Age calculator", "operationId": "calendar_date_post_v1_date_age", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "calendar_date", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "age_years": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/date/age.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "dob": { "type": "string", "default": "2000-01-01", "example": "2000-01-01", "description": "Request option: Dob. Default: 2000-01-01" } }, "additionalProperties": false }, "example": { "dob": "2000-01-01" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "dob": { "type": "string", "default": "2000-01-01", "example": "2000-01-01", "description": "Request option: Dob. Default: 2000-01-01" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "age_years" ] } }, "/v1/date/countdown": { "get": { "tags": [ "Calendar & Business Date API" ], "summary": "Countdown", "operationId": "calendar_date_get_v1_date_countdown", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "calendar_date", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "days": [], "start": [], "end": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/date/countdown.php", "parameters": [ { "name": "end", "in": "query", "required": false, "description": "Request option: End. Default: +30 days", "schema": { "type": "string", "default": "+30 days", "example": "+30 days" }, "example": "+30 days" }, { "name": "start", "in": "query", "required": false, "description": "Request option: Start. Default: today", "schema": { "type": "string", "default": "today", "example": "today" }, "example": "today" } ], "x-actoki-response-fields": [ "days", "start", "end" ] }, "post": { "tags": [ "Calendar & Business Date API" ], "summary": "Countdown", "operationId": "calendar_date_post_v1_date_countdown", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "calendar_date", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "days": [], "start": [], "end": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/date/countdown.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "end": { "type": "string", "default": "+30 days", "example": "+30 days", "description": "Request option: End. Default: +30 days" }, "start": { "type": "string", "default": "today", "example": "today", "description": "Request option: Start. Default: today" } }, "additionalProperties": false }, "example": { "end": "+30 days", "start": "today" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "end": { "type": "string", "default": "+30 days", "example": "+30 days", "description": "Request option: End. Default: +30 days" }, "start": { "type": "string", "default": "today", "example": "today", "description": "Request option: Start. Default: today" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "days", "start", "end" ] } }, "/v1/date/payday": { "get": { "tags": [ "Calendar & Business Date API" ], "summary": "Payday helper", "operationId": "calendar_date_get_v1_date_payday", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "calendar_date", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "payday": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/date/payday.php", "parameters": [ { "name": "start", "in": "query", "required": false, "description": "Request option: Start. Default: today", "schema": { "type": "string", "default": "today", "example": "today" }, "example": "today" } ], "x-actoki-response-fields": [ "payday" ] }, "post": { "tags": [ "Calendar & Business Date API" ], "summary": "Payday helper", "operationId": "calendar_date_post_v1_date_payday", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "calendar_date", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "payday": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/date/payday.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "start": { "type": "string", "default": "today", "example": "today", "description": "Request option: Start. Default: today" } }, "additionalProperties": false }, "example": { "start": "today" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "start": { "type": "string", "default": "today", "example": "today", "description": "Request option: Start. Default: today" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "payday" ] } }, "/v1/companies/search": { "get": { "tags": [ "Company Registry API" ], "summary": "Search UK companies by name and, through advanced search, address or postcode.", "operationId": "company_registry_get_v1_companies_search", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "company_registry", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": [], "code": [], "message": [], "company_name": [], "location": [], "size": [], "start_index": [], "q": [], "items_per_page": [], "provider": [], "jurisdiction": [], "query": [], "name": [], "address": [], "postcode": [], "pagination": [], "page": [], "per_page": [], "total": [], "results": [], "retrieved_at": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/companies/search.php", "parameters": [ { "name": "name", "in": "query", "required": true, "description": "Human-readable name.", "schema": { "type": "string", "example": "example" }, "example": "example" }, { "name": "q", "in": "query", "required": false, "description": "Request option: Q. Default:", "schema": { "type": "string", "default": "", "example": "example" }, "example": "example" }, { "name": "address", "in": "query", "required": false, "description": "Request option: Address. Default:", "schema": { "type": "string", "default": "", "example": "example" }, "example": "example" }, { "name": "postcode", "in": "query", "required": false, "description": "Request option: Postcode. Default:", "schema": { "type": "string", "default": "", "example": "example" }, "example": "example" }, { "name": "page", "in": "query", "required": false, "description": "Request option: Page. Default: 1", "schema": { "type": "string", "default": 1, "example": 1 }, "example": 1 }, { "name": "per_page", "in": "query", "required": false, "description": "Request option: Per Page. Default: 20", "schema": { "type": "string", "default": 20, "example": 20 }, "example": 20 } ], "x-actoki-response-fields": [ "error", "code", "message", "company_name", "location", "size", "start_index", "q", "items_per_page", "provider", "jurisdiction", "query", "name", "address", "postcode", "pagination", "page", "per_page", "total", "results", "retrieved_at" ] }, "post": { "tags": [ "Company Registry API" ], "summary": "Search UK companies by name and, through advanced search, address or postcode.", "operationId": "company_registry_post_v1_companies_search", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "company_registry", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": [], "code": [], "message": [], "company_name": [], "location": [], "size": [], "start_index": [], "q": [], "items_per_page": [], "provider": [], "jurisdiction": [], "query": [], "name": [], "address": [], "postcode": [], "pagination": [], "page": [], "per_page": [], "total": [], "results": [], "retrieved_at": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/companies/search.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "example", "description": "Human-readable name." }, "q": { "type": "string", "default": "", "example": "example", "description": "Request option: Q. Default:" }, "address": { "type": "string", "default": "", "example": "example", "description": "Request option: Address. Default:" }, "postcode": { "type": "string", "default": "", "example": "example", "description": "Request option: Postcode. Default:" }, "page": { "type": "string", "default": 1, "example": 1, "description": "Request option: Page. Default: 1" }, "per_page": { "type": "string", "default": 20, "example": 20, "description": "Request option: Per Page. Default: 20" } }, "additionalProperties": false, "required": [ "name" ] }, "example": { "name": "example", "q": "example", "address": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "example", "description": "Human-readable name." }, "q": { "type": "string", "default": "", "example": "example", "description": "Request option: Q. Default:" }, "address": { "type": "string", "default": "", "example": "example", "description": "Request option: Address. Default:" }, "postcode": { "type": "string", "default": "", "example": "example", "description": "Request option: Postcode. Default:" }, "page": { "type": "string", "default": 1, "example": 1, "description": "Request option: Page. Default: 1" }, "per_page": { "type": "string", "default": 20, "example": 20, "description": "Request option: Per Page. Default: 20" } }, "additionalProperties": false, "required": [ "name" ] } } } }, "x-actoki-response-fields": [ "error", "code", "message", "company_name", "location", "size", "start_index", "q", "items_per_page", "provider", "jurisdiction", "query", "name", "address", "postcode", "pagination", "page", "per_page", "total", "results", "retrieved_at" ] } }, "/v1/companies/profile": { "get": { "tags": [ "Company Registry API" ], "summary": "Retrieve an official company profile by company number.", "operationId": "company_registry_get_v1_companies_profile", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "company_registry", "x-actoki-units": 4, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": [], "code": [], "message": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/companies/profile.php", "parameters": [ { "name": "jurisdiction", "in": "query", "required": false, "description": "Company-register jurisdiction. The installed production connector currently supports GB/UK. Default: GB · Options: GB, UK", "schema": { "type": "string", "enum": [ "GB", "UK" ], "default": "GB", "example": "GB" }, "example": "GB" }, { "name": "company_number", "in": "query", "required": true, "description": "Official company registration number. Maximum 20 characters", "schema": { "type": "string", "example": "01234567", "maxLength": 20 }, "example": "01234567" } ], "x-actoki-response-fields": [ "error", "code", "message" ] }, "post": { "tags": [ "Company Registry API" ], "summary": "Retrieve an official company profile by company number.", "operationId": "company_registry_post_v1_companies_profile", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "company_registry", "x-actoki-units": 4, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": [], "code": [], "message": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/companies/profile.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "jurisdiction": { "type": "string", "enum": [ "GB", "UK" ], "default": "GB", "example": "GB", "description": "Company-register jurisdiction. The installed production connector currently supports GB/UK. Default: GB · Options: GB, UK" }, "company_number": { "type": "string", "example": "01234567", "maxLength": 20, "description": "Official company registration number. Maximum 20 characters" } }, "additionalProperties": false, "required": [ "company_number" ] }, "example": { "jurisdiction": "GB", "company_number": "01234567" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "jurisdiction": { "type": "string", "enum": [ "GB", "UK" ], "default": "GB", "example": "GB", "description": "Company-register jurisdiction. The installed production connector currently supports GB/UK. Default: GB · Options: GB, UK" }, "company_number": { "type": "string", "example": "01234567", "maxLength": 20, "description": "Official company registration number. Maximum 20 characters" } }, "additionalProperties": false, "required": [ "company_number" ] } } } }, "x-actoki-response-fields": [ "error", "code", "message" ] } }, "/v1/companies/officers": { "get": { "tags": [ "Company Registry API" ], "summary": "Retrieve company officers.", "operationId": "company_registry_get_v1_companies_officers", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "company_registry", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": [], "code": [], "message": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/companies/officers.php", "parameters": [ { "name": "jurisdiction", "in": "query", "required": false, "description": "Company-register jurisdiction. The installed production connector currently supports GB/UK. Default: GB · Options: GB, UK", "schema": { "type": "string", "enum": [ "GB", "UK" ], "default": "GB", "example": "GB" }, "example": "GB" }, { "name": "company_number", "in": "query", "required": true, "description": "Official company registration number. Maximum 20 characters", "schema": { "type": "string", "example": "01234567", "maxLength": 20 }, "example": "01234567" } ], "x-actoki-response-fields": [ "error", "code", "message" ] }, "post": { "tags": [ "Company Registry API" ], "summary": "Retrieve company officers.", "operationId": "company_registry_post_v1_companies_officers", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "company_registry", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": [], "code": [], "message": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/companies/officers.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "jurisdiction": { "type": "string", "enum": [ "GB", "UK" ], "default": "GB", "example": "GB", "description": "Company-register jurisdiction. The installed production connector currently supports GB/UK. Default: GB · Options: GB, UK" }, "company_number": { "type": "string", "example": "01234567", "maxLength": 20, "description": "Official company registration number. Maximum 20 characters" } }, "additionalProperties": false, "required": [ "company_number" ] }, "example": { "jurisdiction": "GB", "company_number": "01234567" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "jurisdiction": { "type": "string", "enum": [ "GB", "UK" ], "default": "GB", "example": "GB", "description": "Company-register jurisdiction. The installed production connector currently supports GB/UK. Default: GB · Options: GB, UK" }, "company_number": { "type": "string", "example": "01234567", "maxLength": 20, "description": "Official company registration number. Maximum 20 characters" } }, "additionalProperties": false, "required": [ "company_number" ] } } } }, "x-actoki-response-fields": [ "error", "code", "message" ] } }, "/v1/companies/psc": { "get": { "tags": [ "Company Registry API" ], "summary": "Retrieve persons with significant control.", "operationId": "company_registry_get_v1_companies_psc", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "company_registry", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": [], "code": [], "message": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/companies/psc.php", "parameters": [ { "name": "jurisdiction", "in": "query", "required": false, "description": "Company-register jurisdiction. The installed production connector currently supports GB/UK. Default: GB · Options: GB, UK", "schema": { "type": "string", "enum": [ "GB", "UK" ], "default": "GB", "example": "GB" }, "example": "GB" }, { "name": "company_number", "in": "query", "required": true, "description": "Official company registration number. Maximum 20 characters", "schema": { "type": "string", "example": "01234567", "maxLength": 20 }, "example": "01234567" } ], "x-actoki-response-fields": [ "error", "code", "message" ] }, "post": { "tags": [ "Company Registry API" ], "summary": "Retrieve persons with significant control.", "operationId": "company_registry_post_v1_companies_psc", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "company_registry", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": [], "code": [], "message": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/companies/psc.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "jurisdiction": { "type": "string", "enum": [ "GB", "UK" ], "default": "GB", "example": "GB", "description": "Company-register jurisdiction. The installed production connector currently supports GB/UK. Default: GB · Options: GB, UK" }, "company_number": { "type": "string", "example": "01234567", "maxLength": 20, "description": "Official company registration number. Maximum 20 characters" } }, "additionalProperties": false, "required": [ "company_number" ] }, "example": { "jurisdiction": "GB", "company_number": "01234567" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "jurisdiction": { "type": "string", "enum": [ "GB", "UK" ], "default": "GB", "example": "GB", "description": "Company-register jurisdiction. The installed production connector currently supports GB/UK. Default: GB · Options: GB, UK" }, "company_number": { "type": "string", "example": "01234567", "maxLength": 20, "description": "Official company registration number. Maximum 20 characters" } }, "additionalProperties": false, "required": [ "company_number" ] } } } }, "x-actoki-response-fields": [ "error", "code", "message" ] } }, "/v1/companies/filing-history": { "get": { "tags": [ "Company Registry API" ], "summary": "Retrieve filing history.", "operationId": "company_registry_get_v1_companies_filing_history", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "company_registry", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": [], "code": [], "message": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/companies/filing-history.php", "parameters": [ { "name": "jurisdiction", "in": "query", "required": false, "description": "Company-register jurisdiction. The installed production connector currently supports GB/UK. Default: GB · Options: GB, UK", "schema": { "type": "string", "enum": [ "GB", "UK" ], "default": "GB", "example": "GB" }, "example": "GB" }, { "name": "company_number", "in": "query", "required": true, "description": "Official company registration number. Maximum 20 characters", "schema": { "type": "string", "example": "01234567", "maxLength": 20 }, "example": "01234567" } ], "x-actoki-response-fields": [ "error", "code", "message" ] }, "post": { "tags": [ "Company Registry API" ], "summary": "Retrieve filing history.", "operationId": "company_registry_post_v1_companies_filing_history", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "company_registry", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": [], "code": [], "message": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/companies/filing-history.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "jurisdiction": { "type": "string", "enum": [ "GB", "UK" ], "default": "GB", "example": "GB", "description": "Company-register jurisdiction. The installed production connector currently supports GB/UK. Default: GB · Options: GB, UK" }, "company_number": { "type": "string", "example": "01234567", "maxLength": 20, "description": "Official company registration number. Maximum 20 characters" } }, "additionalProperties": false, "required": [ "company_number" ] }, "example": { "jurisdiction": "GB", "company_number": "01234567" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "jurisdiction": { "type": "string", "enum": [ "GB", "UK" ], "default": "GB", "example": "GB", "description": "Company-register jurisdiction. The installed production connector currently supports GB/UK. Default: GB · Options: GB, UK" }, "company_number": { "type": "string", "example": "01234567", "maxLength": 20, "description": "Official company registration number. Maximum 20 characters" } }, "additionalProperties": false, "required": [ "company_number" ] } } } }, "x-actoki-response-fields": [ "error", "code", "message" ] } }, "/v1/companies/charges": { "get": { "tags": [ "Company Registry API" ], "summary": "Retrieve registered charges.", "operationId": "company_registry_get_v1_companies_charges", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "company_registry", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": [], "code": [], "message": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/companies/charges.php", "parameters": [ { "name": "jurisdiction", "in": "query", "required": false, "description": "Company-register jurisdiction. The installed production connector currently supports GB/UK. Default: GB · Options: GB, UK", "schema": { "type": "string", "enum": [ "GB", "UK" ], "default": "GB", "example": "GB" }, "example": "GB" }, { "name": "company_number", "in": "query", "required": true, "description": "Official company registration number. Maximum 20 characters", "schema": { "type": "string", "example": "01234567", "maxLength": 20 }, "example": "01234567" } ], "x-actoki-response-fields": [ "error", "code", "message" ] }, "post": { "tags": [ "Company Registry API" ], "summary": "Retrieve registered charges.", "operationId": "company_registry_post_v1_companies_charges", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "company_registry", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": [], "code": [], "message": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/companies/charges.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "jurisdiction": { "type": "string", "enum": [ "GB", "UK" ], "default": "GB", "example": "GB", "description": "Company-register jurisdiction. The installed production connector currently supports GB/UK. Default: GB · Options: GB, UK" }, "company_number": { "type": "string", "example": "01234567", "maxLength": 20, "description": "Official company registration number. Maximum 20 characters" } }, "additionalProperties": false, "required": [ "company_number" ] }, "example": { "jurisdiction": "GB", "company_number": "01234567" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "jurisdiction": { "type": "string", "enum": [ "GB", "UK" ], "default": "GB", "example": "GB", "description": "Company-register jurisdiction. The installed production connector currently supports GB/UK. Default: GB · Options: GB, UK" }, "company_number": { "type": "string", "example": "01234567", "maxLength": 20, "description": "Official company registration number. Maximum 20 characters" } }, "additionalProperties": false, "required": [ "company_number" ] } } } }, "x-actoki-response-fields": [ "error", "code", "message" ] } }, "/v1/companies/sources": { "get": { "tags": [ "Company Registry API" ], "summary": "List company-register providers and coverage.", "operationId": "company_registry_get_v1_companies_sources", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "company_registry", "x-actoki-units": 1, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": [], "code": [], "message": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "query string" ], "x-actoki-source": "httpdocs/v1/companies/sources.php", "parameters": [], "x-actoki-response-fields": [ "error", "code", "message" ] } }, "/v1/compliance/pii-scan": { "get": { "tags": [ "Compliance & GDPR Tools API" ], "summary": "PII scanner", "operationId": "compliance_tools_get_v1_compliance_pii_scan", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "compliance_tools", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "service": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/compliance/pii-scan.php", "parameters": [ { "name": "text", "in": "query", "required": true, "description": "Text to scan for personal information. Maximum 100000 characters", "schema": { "type": "string", "example": "Contact Jane at jane@example.com.", "maxLength": 100000 }, "example": "Contact Jane at jane@example.com." } ], "x-actoki-response-fields": [ "service" ] }, "post": { "tags": [ "Compliance & GDPR Tools API" ], "summary": "PII scanner", "operationId": "compliance_tools_post_v1_compliance_pii_scan", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "compliance_tools", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "service": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/compliance/pii-scan.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "Contact Jane at jane@example.com.", "maxLength": 100000, "description": "Text to scan for personal information. Maximum 100000 characters" } }, "additionalProperties": false, "required": [ "text" ] }, "example": { "text": "Contact Jane at jane@example.com." } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "Contact Jane at jane@example.com.", "maxLength": 100000, "description": "Text to scan for personal information. Maximum 100000 characters" } }, "additionalProperties": false, "required": [ "text" ] } } } }, "x-actoki-response-fields": [ "service" ] } }, "/v1/compliance/redaction": { "get": { "tags": [ "Compliance & GDPR Tools API" ], "summary": "Redact PII/secrets", "operationId": "compliance_tools_get_v1_compliance_redaction", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "compliance_tools", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "redacted": [], "service": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/compliance/redaction.php", "parameters": [ { "name": "text", "in": "query", "required": true, "description": "Text to process. Maximum 200000 characters", "schema": { "type": "string", "example": "example", "maxLength": 200000 }, "example": "example" } ], "x-actoki-response-fields": [ "redacted", "service" ] }, "post": { "tags": [ "Compliance & GDPR Tools API" ], "summary": "Redact PII/secrets", "operationId": "compliance_tools_post_v1_compliance_redaction", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "compliance_tools", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "redacted": [], "service": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/compliance/redaction.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "example", "maxLength": 200000, "description": "Text to process. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "text" ] }, "example": { "text": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "example", "maxLength": 200000, "description": "Text to process. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "text" ] } } } }, "x-actoki-response-fields": [ "redacted", "service" ] } }, "/v1/compliance/retention-check": { "get": { "tags": [ "Compliance & GDPR Tools API" ], "summary": "Retention policy check", "operationId": "compliance_tools_get_v1_compliance_retention_check", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "compliance_tools", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "retention_days": [], "age_days": [], "delete_recommended": [], "note": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/compliance/retention-check.php", "parameters": [ { "name": "retention_days", "in": "query", "required": false, "description": "Request option: Retention Days. Default: 365 · Min: 0 · Max: 3650", "schema": { "type": "integer", "default": 365, "example": 365, "minimum": 0, "maximum": 3650 }, "example": 365 }, { "name": "created_at", "in": "query", "required": false, "description": "Request option: Created At. Default: now", "schema": { "type": "string", "default": "now", "example": "now" }, "example": "now" } ], "x-actoki-response-fields": [ "retention_days", "age_days", "delete_recommended", "note" ] }, "post": { "tags": [ "Compliance & GDPR Tools API" ], "summary": "Retention policy check", "operationId": "compliance_tools_post_v1_compliance_retention_check", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "compliance_tools", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "retention_days": [], "age_days": [], "delete_recommended": [], "note": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/compliance/retention-check.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "retention_days": { "type": "integer", "default": 365, "example": 365, "minimum": 0, "maximum": 3650, "description": "Request option: Retention Days. Default: 365 · Min: 0 · Max: 3650" }, "created_at": { "type": "string", "default": "now", "example": "now", "description": "Request option: Created At. Default: now" } }, "additionalProperties": false }, "example": { "retention_days": 365, "created_at": "now" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "retention_days": { "type": "integer", "default": 365, "example": 365, "minimum": 0, "maximum": 3650, "description": "Request option: Retention Days. Default: 365 · Min: 0 · Max: 3650" }, "created_at": { "type": "string", "default": "now", "example": "now", "description": "Request option: Created At. Default: now" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "retention_days", "age_days", "delete_recommended", "note" ] } }, "/v1/compliance/cookie-audit": { "get": { "tags": [ "Compliance & GDPR Tools API" ], "summary": "Cookie text audit", "operationId": "compliance_tools_get_v1_compliance_cookie_audit", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "compliance_tools", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "mentions": [], "needs_cookie_notice": [], "note": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/compliance/cookie-audit.php", "parameters": [ { "name": "text", "in": "query", "required": true, "description": "Text to process. Maximum 200000 characters", "schema": { "type": "string", "example": "example", "maxLength": 200000 }, "example": "example" } ], "x-actoki-response-fields": [ "mentions", "needs_cookie_notice", "note" ] }, "post": { "tags": [ "Compliance & GDPR Tools API" ], "summary": "Cookie text audit", "operationId": "compliance_tools_post_v1_compliance_cookie_audit", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "compliance_tools", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "mentions": [], "needs_cookie_notice": [], "note": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/compliance/cookie-audit.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "example", "maxLength": 200000, "description": "Text to process. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "text" ] }, "example": { "text": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "example", "maxLength": 200000, "description": "Text to process. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "text" ] } } } }, "x-actoki-response-fields": [ "mentions", "needs_cookie_notice", "note" ] } }, "/v1/compliance/privacy-policy-check": { "get": { "tags": [ "Compliance & GDPR Tools API" ], "summary": "Privacy policy content check", "operationId": "compliance_tools_get_v1_compliance_privacy_policy_check", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "compliance_tools", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "checks": [], "score": [], "not_legal_advice": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/compliance/privacy-policy-check.php", "parameters": [ { "name": "text", "in": "query", "required": true, "description": "Text to process. Maximum 200000 characters", "schema": { "type": "string", "example": "example", "maxLength": 200000 }, "example": "example" } ], "x-actoki-response-fields": [ "checks", "score", "not_legal_advice" ] }, "post": { "tags": [ "Compliance & GDPR Tools API" ], "summary": "Privacy policy content check", "operationId": "compliance_tools_post_v1_compliance_privacy_policy_check", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "compliance_tools", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "checks": [], "score": [], "not_legal_advice": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/compliance/privacy-policy-check.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "example", "maxLength": 200000, "description": "Text to process. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "text" ] }, "example": { "text": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "example", "maxLength": 200000, "description": "Text to process. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "text" ] } } } }, "x-actoki-response-fields": [ "checks", "score", "not_legal_advice" ] } }, "/v1/content/profanity": { "get": { "tags": [ "Content Safety & Text Intelligence API" ], "summary": "Detect profanity in text", "operationId": "content_tools_get_v1_content_profanity", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "content_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "contains_profanity": [], "matches": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/content/profanity.php", "parameters": [ { "name": "text", "in": "query", "required": true, "description": "Text to process. Maximum 100000 characters", "schema": { "type": "string", "example": "example", "maxLength": 100000 }, "example": "example" } ], "x-actoki-response-fields": [ "contains_profanity", "matches" ] }, "post": { "tags": [ "Content Safety & Text Intelligence API" ], "summary": "Detect profanity in text", "operationId": "content_tools_post_v1_content_profanity", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "content_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "contains_profanity": [], "matches": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/content/profanity.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "example", "maxLength": 100000, "description": "Text to process. Maximum 100000 characters" } }, "additionalProperties": false, "required": [ "text" ] }, "example": { "text": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "example", "maxLength": 100000, "description": "Text to process. Maximum 100000 characters" } }, "additionalProperties": false, "required": [ "text" ] } } } }, "x-actoki-response-fields": [ "contains_profanity", "matches" ] } }, "/v1/content/pii-detect": { "get": { "tags": [ "Content Safety & Text Intelligence API" ], "summary": "Detect emails, phone numbers and basic PII", "operationId": "content_tools_get_v1_content_pii_detect", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "content_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "email_count": [], "phone_count": [], "has_pii": [], "emails": [], "phones": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/content/pii-detect.php", "parameters": [ { "name": "text", "in": "query", "required": true, "description": "Text to process. Maximum 100000 characters", "schema": { "type": "string", "example": "example", "maxLength": 100000 }, "example": "example" } ], "x-actoki-response-fields": [ "email_count", "phone_count", "has_pii", "emails", "phones" ] }, "post": { "tags": [ "Content Safety & Text Intelligence API" ], "summary": "Detect emails, phone numbers and basic PII", "operationId": "content_tools_post_v1_content_pii_detect", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "content_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "email_count": [], "phone_count": [], "has_pii": [], "emails": [], "phones": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/content/pii-detect.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "example", "maxLength": 100000, "description": "Text to process. Maximum 100000 characters" } }, "additionalProperties": false, "required": [ "text" ] }, "example": { "text": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "example", "maxLength": 100000, "description": "Text to process. Maximum 100000 characters" } }, "additionalProperties": false, "required": [ "text" ] } } } }, "x-actoki-response-fields": [ "email_count", "phone_count", "has_pii", "emails", "phones" ] } }, "/v1/content/redact": { "get": { "tags": [ "Content Safety & Text Intelligence API" ], "summary": "Redact basic PII", "operationId": "content_tools_get_v1_content_redact", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "content_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "redacted": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/content/redact.php", "parameters": [ { "name": "text", "in": "query", "required": true, "description": "Text to process. Maximum 100000 characters", "schema": { "type": "string", "example": "example", "maxLength": 100000 }, "example": "example" } ], "x-actoki-response-fields": [ "redacted" ] }, "post": { "tags": [ "Content Safety & Text Intelligence API" ], "summary": "Redact basic PII", "operationId": "content_tools_post_v1_content_redact", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "content_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "redacted": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/content/redact.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "example", "maxLength": 100000, "description": "Text to process. Maximum 100000 characters" } }, "additionalProperties": false, "required": [ "text" ] }, "example": { "text": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "example", "maxLength": 100000, "description": "Text to process. Maximum 100000 characters" } }, "additionalProperties": false, "required": [ "text" ] } } } }, "x-actoki-response-fields": [ "redacted" ] } }, "/v1/content/language-detect": { "get": { "tags": [ "Content Safety & Text Intelligence API" ], "summary": "Detect likely language", "operationId": "content_tools_get_v1_content_language_detect", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "content_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "language": [], "confidence": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/content/language-detect.php", "parameters": [ { "name": "text", "in": "query", "required": true, "description": "Text to process. Maximum 100000 characters", "schema": { "type": "string", "example": "example", "maxLength": 100000 }, "example": "example" } ], "x-actoki-response-fields": [ "language", "confidence" ] }, "post": { "tags": [ "Content Safety & Text Intelligence API" ], "summary": "Detect likely language", "operationId": "content_tools_post_v1_content_language_detect", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "content_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "language": [], "confidence": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/content/language-detect.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "example", "maxLength": 100000, "description": "Text to process. Maximum 100000 characters" } }, "additionalProperties": false, "required": [ "text" ] }, "example": { "text": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "example", "maxLength": 100000, "description": "Text to process. Maximum 100000 characters" } }, "additionalProperties": false, "required": [ "text" ] } } } }, "x-actoki-response-fields": [ "language", "confidence" ] } }, "/v1/content/readability": { "get": { "tags": [ "Content Safety & Text Intelligence API" ], "summary": "Readability score", "operationId": "content_tools_get_v1_content_readability", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "content_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/content/readability.php", "parameters": [ { "name": "text", "in": "query", "required": true, "description": "Text to process. Maximum 100000 characters", "schema": { "type": "string", "example": "example", "maxLength": 100000 }, "example": "example" } ] }, "post": { "tags": [ "Content Safety & Text Intelligence API" ], "summary": "Readability score", "operationId": "content_tools_post_v1_content_readability", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "content_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/content/readability.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "example", "maxLength": 100000, "description": "Text to process. Maximum 100000 characters" } }, "additionalProperties": false, "required": [ "text" ] }, "example": { "text": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "example", "maxLength": 100000, "description": "Text to process. Maximum 100000 characters" } }, "additionalProperties": false, "required": [ "text" ] } } } } } }, "/v1/content/sentiment-basic": { "get": { "tags": [ "Content Safety & Text Intelligence API" ], "summary": "Basic sentiment score", "operationId": "content_tools_get_v1_content_sentiment_basic", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "content_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "sentiment": [], "positive_hits": [], "negative_hits": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/content/sentiment-basic.php", "parameters": [ { "name": "text", "in": "query", "required": true, "description": "Text to process. Maximum 100000 characters", "schema": { "type": "string", "example": "example", "maxLength": 100000 }, "example": "example" } ], "x-actoki-response-fields": [ "sentiment", "positive_hits", "negative_hits" ] }, "post": { "tags": [ "Content Safety & Text Intelligence API" ], "summary": "Basic sentiment score", "operationId": "content_tools_post_v1_content_sentiment_basic", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "content_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "sentiment": [], "positive_hits": [], "negative_hits": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/content/sentiment-basic.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "example", "maxLength": 100000, "description": "Text to process. Maximum 100000 characters" } }, "additionalProperties": false, "required": [ "text" ] }, "example": { "text": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "example", "maxLength": 100000, "description": "Text to process. Maximum 100000 characters" } }, "additionalProperties": false, "required": [ "text" ] } } } }, "x-actoki-response-fields": [ "sentiment", "positive_hits", "negative_hits" ] } }, "/v1/convert/unit": { "get": { "tags": [ "Conversion API" ], "summary": "Convert common measurement units.", "operationId": "conversion_get_v1_convert_unit", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "conversion", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/convert/unit.php", "parameters": [ { "name": "value", "in": "query", "required": false, "description": "Request option: Value. Default: 1", "schema": { "type": "number", "default": 1, "example": 1 }, "example": 1 }, { "name": "from", "in": "query", "required": false, "description": "Request option: From. Default: m · Maximum 40 characters", "schema": { "type": "string", "default": "m", "example": "m", "maxLength": 40 }, "example": "m" }, { "name": "to", "in": "query", "required": false, "description": "Request option: To. Default: km · Maximum 40 characters", "schema": { "type": "string", "default": "km", "example": "km", "maxLength": 40 }, "example": "km" } ] }, "post": { "tags": [ "Conversion API" ], "summary": "Convert common measurement units.", "operationId": "conversion_post_v1_convert_unit", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "conversion", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/convert/unit.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "value": { "type": "number", "default": 1, "example": 1, "description": "Request option: Value. Default: 1" }, "from": { "type": "string", "default": "m", "example": "m", "maxLength": 40, "description": "Request option: From. Default: m · Maximum 40 characters" }, "to": { "type": "string", "default": "km", "example": "km", "maxLength": 40, "description": "Request option: To. Default: km · Maximum 40 characters" } }, "additionalProperties": false }, "example": { "value": 1, "from": "m", "to": "km" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "value": { "type": "number", "default": 1, "example": 1, "description": "Request option: Value. Default: 1" }, "from": { "type": "string", "default": "m", "example": "m", "maxLength": 40, "description": "Request option: From. Default: m · Maximum 40 characters" }, "to": { "type": "string", "default": "km", "example": "km", "maxLength": 40, "description": "Request option: To. Default: km · Maximum 40 characters" } }, "additionalProperties": false } } } } } }, "/v1/convert/batch": { "get": { "tags": [ "Conversion API" ], "summary": "Batch unit conversion.", "operationId": "conversion_get_v1_convert_batch", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "conversion", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/convert/batch.php", "parameters": [ { "name": "items", "in": "query", "required": false, "description": "Array of input items.", "schema": { "type": "array", "items": { "type": "string" }, "example": [] }, "example": [] } ], "x-actoki-response-fields": [ "items" ] }, "post": { "tags": [ "Conversion API" ], "summary": "Batch unit conversion.", "operationId": "conversion_post_v1_convert_batch", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "conversion", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/convert/batch.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "string" }, "example": [], "description": "Array of input items." } }, "additionalProperties": false }, "example": { "items": [] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "string" }, "example": [], "description": "Array of input items." } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "items" ] } }, "/v1/convert/timezone": { "get": { "tags": [ "Conversion API" ], "summary": "Convert a time between time zones.", "operationId": "conversion_get_v1_convert_timezone", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "conversion", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "time": [], "error": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/convert/timezone.php", "parameters": [ { "name": "time", "in": "query", "required": false, "description": "Request option: Time. Default: now · Maximum 80 characters", "schema": { "type": "string", "default": "now", "example": "now", "maxLength": 80 }, "example": "now" }, { "name": "from", "in": "query", "required": false, "description": "Request option: From. Default: UTC · Maximum 80 characters", "schema": { "type": "string", "default": "UTC", "example": "UTC", "maxLength": 80 }, "example": "UTC" }, { "name": "to", "in": "query", "required": false, "description": "Request option: To. Default: Europe/London · Maximum 80 characters", "schema": { "type": "string", "default": "Europe/London", "example": "Europe/London", "maxLength": 80 }, "example": "Europe/London" } ], "x-actoki-response-fields": [ "time", "error" ] }, "post": { "tags": [ "Conversion API" ], "summary": "Convert a time between time zones.", "operationId": "conversion_post_v1_convert_timezone", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "conversion", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "time": [], "error": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/convert/timezone.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "time": { "type": "string", "default": "now", "example": "now", "maxLength": 80, "description": "Request option: Time. Default: now · Maximum 80 characters" }, "from": { "type": "string", "default": "UTC", "example": "UTC", "maxLength": 80, "description": "Request option: From. Default: UTC · Maximum 80 characters" }, "to": { "type": "string", "default": "Europe/London", "example": "Europe/London", "maxLength": 80, "description": "Request option: To. Default: Europe/London · Maximum 80 characters" } }, "additionalProperties": false }, "example": { "time": "now", "from": "UTC", "to": "Europe/London" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "time": { "type": "string", "default": "now", "example": "now", "maxLength": 80, "description": "Request option: Time. Default: now · Maximum 80 characters" }, "from": { "type": "string", "default": "UTC", "example": "UTC", "maxLength": 80, "description": "Request option: From. Default: UTC · Maximum 80 characters" }, "to": { "type": "string", "default": "Europe/London", "example": "Europe/London", "maxLength": 80, "description": "Request option: To. Default: Europe/London · Maximum 80 characters" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "time", "error" ] } }, "/v1/convert/temperature": { "get": { "tags": [ "Conversion API" ], "summary": "Temperature conversion.", "operationId": "conversion_get_v1_convert_temperature", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "conversion", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/convert/temperature.php", "parameters": [ { "name": "value", "in": "query", "required": false, "description": "Request option: Value. Default: 1", "schema": { "type": "number", "default": 1, "example": 1 }, "example": 1 }, { "name": "from", "in": "query", "required": false, "description": "Request option: From. Default: m · Maximum 40 characters", "schema": { "type": "string", "default": "m", "example": "m", "maxLength": 40 }, "example": "m" }, { "name": "to", "in": "query", "required": false, "description": "Request option: To. Default: km · Maximum 40 characters", "schema": { "type": "string", "default": "km", "example": "km", "maxLength": 40 }, "example": "km" } ] }, "post": { "tags": [ "Conversion API" ], "summary": "Temperature conversion.", "operationId": "conversion_post_v1_convert_temperature", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "conversion", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/convert/temperature.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "value": { "type": "number", "default": 1, "example": 1, "description": "Request option: Value. Default: 1" }, "from": { "type": "string", "default": "m", "example": "m", "maxLength": 40, "description": "Request option: From. Default: m · Maximum 40 characters" }, "to": { "type": "string", "default": "km", "example": "km", "maxLength": 40, "description": "Request option: To. Default: km · Maximum 40 characters" } }, "additionalProperties": false }, "example": { "value": 1, "from": "m", "to": "km" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "value": { "type": "number", "default": 1, "example": 1, "description": "Request option: Value. Default: 1" }, "from": { "type": "string", "default": "m", "example": "m", "maxLength": 40, "description": "Request option: From. Default: m · Maximum 40 characters" }, "to": { "type": "string", "default": "km", "example": "km", "maxLength": 40, "description": "Request option: To. Default: km · Maximum 40 characters" } }, "additionalProperties": false } } } } } }, "/v1/convert/file-size": { "get": { "tags": [ "Conversion API" ], "summary": "Digital storage conversion.", "operationId": "conversion_get_v1_convert_file_size", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "conversion", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/convert/file-size.php", "parameters": [ { "name": "value", "in": "query", "required": false, "description": "Request option: Value. Default: 1", "schema": { "type": "number", "default": 1, "example": 1 }, "example": 1 }, { "name": "from", "in": "query", "required": false, "description": "Request option: From. Default: m · Maximum 40 characters", "schema": { "type": "string", "default": "m", "example": "m", "maxLength": 40 }, "example": "m" }, { "name": "to", "in": "query", "required": false, "description": "Request option: To. Default: km · Maximum 40 characters", "schema": { "type": "string", "default": "km", "example": "km", "maxLength": 40 }, "example": "km" } ] }, "post": { "tags": [ "Conversion API" ], "summary": "Digital storage conversion.", "operationId": "conversion_post_v1_convert_file_size", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "conversion", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/convert/file-size.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "value": { "type": "number", "default": 1, "example": 1, "description": "Request option: Value. Default: 1" }, "from": { "type": "string", "default": "m", "example": "m", "maxLength": 40, "description": "Request option: From. Default: m · Maximum 40 characters" }, "to": { "type": "string", "default": "km", "example": "km", "maxLength": 40, "description": "Request option: To. Default: km · Maximum 40 characters" } }, "additionalProperties": false }, "example": { "value": 1, "from": "m", "to": "km" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "value": { "type": "number", "default": 1, "example": 1, "description": "Request option: Value. Default: 1" }, "from": { "type": "string", "default": "m", "example": "m", "maxLength": 40, "description": "Request option: From. Default: m · Maximum 40 characters" }, "to": { "type": "string", "default": "km", "example": "km", "maxLength": 40, "description": "Request option: To. Default: km · Maximum 40 characters" } }, "additionalProperties": false } } } } } }, "/v1/password": { "get": { "tags": [ "Core Utilities" ], "summary": "1Password-style password generator: random passwords, memorable word passwords and numeric PINs.", "operationId": "core_get_v1_password", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "core", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/password.php", "parameters": [ { "name": "words", "in": "query", "required": false, "description": "Request option: Words. Default: 4 · Min: 3 · Max: 10 · Options: memorable, words, pin, pins, numeric", "schema": { "type": "integer", "enum": [ "memorable", "words", "pin", "pins", "numeric" ], "default": 4, "example": 4, "minimum": 3, "maximum": 10 }, "example": 4 }, { "name": "separator", "in": "query", "required": false, "description": "Request option: Separator. Default: - · Maximum 3 characters", "schema": { "type": "string", "default": "-", "example": "-", "maxLength": 3 }, "example": "-" }, { "name": "capitalize", "in": "query", "required": false, "description": "Request option: Capitalize. Default: true", "schema": { "type": "boolean", "default": true, "example": true }, "example": true }, { "name": "numbers", "in": "query", "required": false, "description": "Request option: Numbers. Default: true", "schema": { "type": "boolean", "default": true, "example": true }, "example": true }, { "name": "digits", "in": "query", "required": false, "description": "Request option: Digits. Default: 6 · Min: 4 · Max: 32 · Options: memorable, words, pin, pins, numeric", "schema": { "type": "integer", "enum": [ "memorable", "words", "pin", "pins", "numeric" ], "default": 6, "example": 6, "minimum": 4, "maximum": 32 }, "example": 6 }, { "name": "group", "in": "query", "required": false, "description": "Request option: Group. Default: 0 · Min: 0 · Max: 8", "schema": { "type": "integer", "default": 0, "example": 0, "minimum": 0, "maximum": 8 }, "example": 0 }, { "name": "length", "in": "query", "required": false, "description": "Request option: Length. Default: 20 · Min: 8 · Max: 128", "schema": { "type": "integer", "default": 20, "example": 20, "minimum": 8, "maximum": 128 }, "example": 20 }, { "name": "uppercase", "in": "query", "required": false, "description": "Request option: Uppercase. Default: true", "schema": { "type": "boolean", "default": true, "example": true }, "example": true }, { "name": "lowercase", "in": "query", "required": false, "description": "Request option: Lowercase. Default: true", "schema": { "type": "boolean", "default": true, "example": true }, "example": true }, { "name": "symbols", "in": "query", "required": false, "description": "Request option: Symbols. Default: false", "schema": { "type": "boolean", "default": false, "example": false }, "example": false }, { "name": "avoid_ambiguous", "in": "query", "required": false, "description": "Request option: Avoid Ambiguous. Default: true", "schema": { "type": "boolean", "default": true, "example": true }, "example": true }, { "name": "min_numbers", "in": "query", "required": true, "description": "Request option: Min Numbers. Min: 0 · Max: 32", "schema": { "type": "integer", "example": 1, "minimum": 0, "maximum": 32 }, "example": 1 }, { "name": "min_symbols", "in": "query", "required": true, "description": "Request option: Min Symbols. Min: 0 · Max: 32", "schema": { "type": "integer", "example": 1, "minimum": 0, "maximum": 32 }, "example": 1 }, { "name": "type", "in": "query", "required": false, "description": "Request option: Type.", "schema": { "type": "string", "example": "example" }, "example": "example" } ], "x-actoki-response-fields": [ "type" ] }, "post": { "tags": [ "Core Utilities" ], "summary": "1Password-style password generator: random passwords, memorable word passwords and numeric PINs.", "operationId": "core_post_v1_password", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "core", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/password.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "words": { "type": "integer", "enum": [ "memorable", "words", "pin", "pins", "numeric" ], "default": 4, "example": 4, "minimum": 3, "maximum": 10, "description": "Request option: Words. Default: 4 · Min: 3 · Max: 10 · Options: memorable, words, pin, pins, numeric" }, "separator": { "type": "string", "default": "-", "example": "-", "maxLength": 3, "description": "Request option: Separator. Default: - · Maximum 3 characters" }, "capitalize": { "type": "boolean", "default": true, "example": true, "description": "Request option: Capitalize. Default: true" }, "numbers": { "type": "boolean", "default": true, "example": true, "description": "Request option: Numbers. Default: true" }, "digits": { "type": "integer", "enum": [ "memorable", "words", "pin", "pins", "numeric" ], "default": 6, "example": 6, "minimum": 4, "maximum": 32, "description": "Request option: Digits. Default: 6 · Min: 4 · Max: 32 · Options: memorable, words, pin, pins, numeric" }, "group": { "type": "integer", "default": 0, "example": 0, "minimum": 0, "maximum": 8, "description": "Request option: Group. Default: 0 · Min: 0 · Max: 8" }, "length": { "type": "integer", "default": 20, "example": 20, "minimum": 8, "maximum": 128, "description": "Request option: Length. Default: 20 · Min: 8 · Max: 128" }, "uppercase": { "type": "boolean", "default": true, "example": true, "description": "Request option: Uppercase. Default: true" }, "lowercase": { "type": "boolean", "default": true, "example": true, "description": "Request option: Lowercase. Default: true" }, "symbols": { "type": "boolean", "default": false, "example": false, "description": "Request option: Symbols. Default: false" }, "avoid_ambiguous": { "type": "boolean", "default": true, "example": true, "description": "Request option: Avoid Ambiguous. Default: true" }, "min_numbers": { "type": "integer", "example": 1, "minimum": 0, "maximum": 32, "description": "Request option: Min Numbers. Min: 0 · Max: 32" }, "min_symbols": { "type": "integer", "example": 1, "minimum": 0, "maximum": 32, "description": "Request option: Min Symbols. Min: 0 · Max: 32" }, "type": { "type": "string", "example": "example", "description": "Request option: Type." } }, "additionalProperties": false, "required": [ "min_numbers", "min_symbols" ] }, "example": { "words": 4, "separator": "-", "capitalize": true, "min_numbers": 1, "min_symbols": 1 } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "words": { "type": "integer", "enum": [ "memorable", "words", "pin", "pins", "numeric" ], "default": 4, "example": 4, "minimum": 3, "maximum": 10, "description": "Request option: Words. Default: 4 · Min: 3 · Max: 10 · Options: memorable, words, pin, pins, numeric" }, "separator": { "type": "string", "default": "-", "example": "-", "maxLength": 3, "description": "Request option: Separator. Default: - · Maximum 3 characters" }, "capitalize": { "type": "boolean", "default": true, "example": true, "description": "Request option: Capitalize. Default: true" }, "numbers": { "type": "boolean", "default": true, "example": true, "description": "Request option: Numbers. Default: true" }, "digits": { "type": "integer", "enum": [ "memorable", "words", "pin", "pins", "numeric" ], "default": 6, "example": 6, "minimum": 4, "maximum": 32, "description": "Request option: Digits. Default: 6 · Min: 4 · Max: 32 · Options: memorable, words, pin, pins, numeric" }, "group": { "type": "integer", "default": 0, "example": 0, "minimum": 0, "maximum": 8, "description": "Request option: Group. Default: 0 · Min: 0 · Max: 8" }, "length": { "type": "integer", "default": 20, "example": 20, "minimum": 8, "maximum": 128, "description": "Request option: Length. Default: 20 · Min: 8 · Max: 128" }, "uppercase": { "type": "boolean", "default": true, "example": true, "description": "Request option: Uppercase. Default: true" }, "lowercase": { "type": "boolean", "default": true, "example": true, "description": "Request option: Lowercase. Default: true" }, "symbols": { "type": "boolean", "default": false, "example": false, "description": "Request option: Symbols. Default: false" }, "avoid_ambiguous": { "type": "boolean", "default": true, "example": true, "description": "Request option: Avoid Ambiguous. Default: true" }, "min_numbers": { "type": "integer", "example": 1, "minimum": 0, "maximum": 32, "description": "Request option: Min Numbers. Min: 0 · Max: 32" }, "min_symbols": { "type": "integer", "example": 1, "minimum": 0, "maximum": 32, "description": "Request option: Min Symbols. Min: 0 · Max: 32" }, "type": { "type": "string", "example": "example", "description": "Request option: Type." } }, "additionalProperties": false, "required": [ "min_numbers", "min_symbols" ] } } } }, "x-actoki-response-fields": [ "type" ] } }, "/v1/percentage": { "get": { "tags": [ "Core Utilities" ], "summary": "Percentage calculator endpoint.", "operationId": "core_get_v1_percentage", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "core", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/percentage.php", "parameters": [ { "name": "value", "in": "query", "required": false, "description": "Request option: Value.", "schema": { "type": "string", "example": "example" }, "example": "example" }, { "name": "percent", "in": "query", "required": false, "description": "Request option: Percent.", "schema": { "type": "string", "example": "example" }, "example": "example" } ], "x-actoki-response-fields": [ "result" ] }, "post": { "tags": [ "Core Utilities" ], "summary": "Percentage calculator endpoint.", "operationId": "core_post_v1_percentage", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "core", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/percentage.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "value": { "type": "string", "example": "example", "description": "Request option: Value." }, "percent": { "type": "string", "example": "example", "description": "Request option: Percent." } }, "additionalProperties": false }, "example": { "value": "example", "percent": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "value": { "type": "string", "example": "example", "description": "Request option: Value." }, "percent": { "type": "string", "example": "example", "description": "Request option: Percent." } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "result" ] } }, "/v1/data/csv-to-json": { "get": { "tags": [ "Data Formatter API" ], "summary": "CSV to JSON.", "operationId": "data_formatters_get_v1_data_csv_to_json", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "data_formatters", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/data/csv-to-json.php", "parameters": [ { "name": "csv", "in": "query", "required": false, "description": "CSV text including a header row. Default: · Maximum 100000 characters", "schema": { "type": "string", "default": "", "example": "example", "maxLength": 100000 }, "example": "example" } ], "x-actoki-response-fields": [ "rows" ] }, "post": { "tags": [ "Data Formatter API" ], "summary": "CSV to JSON.", "operationId": "data_formatters_post_v1_data_csv_to_json", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "data_formatters", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/data/csv-to-json.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "csv": { "type": "string", "default": "", "example": "example", "maxLength": 100000, "description": "CSV text including a header row. Default: · Maximum 100000 characters" } }, "additionalProperties": false }, "example": { "csv": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "csv": { "type": "string", "default": "", "example": "example", "maxLength": 100000, "description": "CSV text including a header row. Default: · Maximum 100000 characters" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "rows" ] } }, "/v1/data/json-to-csv": { "get": { "tags": [ "Data Formatter API" ], "summary": "JSON to CSV.", "operationId": "data_formatters_get_v1_data_json_to_csv", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "data_formatters", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "csv": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/data/json-to-csv.php", "parameters": [ { "name": "json", "in": "query", "required": false, "description": "JSON text. Default: [] · Maximum 100000 characters", "schema": { "type": "string", "default": "[]", "example": "[]", "maxLength": 100000 }, "example": "[]" } ], "x-actoki-response-fields": [ "csv" ] }, "post": { "tags": [ "Data Formatter API" ], "summary": "JSON to CSV.", "operationId": "data_formatters_post_v1_data_json_to_csv", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "data_formatters", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "csv": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/data/json-to-csv.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "json": { "type": "string", "default": "[]", "example": "[]", "maxLength": 100000, "description": "JSON text. Default: [] · Maximum 100000 characters" } }, "additionalProperties": false }, "example": { "json": "[]" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "json": { "type": "string", "default": "[]", "example": "[]", "maxLength": 100000, "description": "JSON text. Default: [] · Maximum 100000 characters" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "csv" ] } }, "/v1/data/xml-to-json": { "get": { "tags": [ "Data Formatter API" ], "summary": "XML to JSON.", "operationId": "data_formatters_get_v1_data_xml_to_json", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "data_formatters", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "json": [], "error": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/data/xml-to-json.php", "parameters": [ { "name": "xml", "in": "query", "required": false, "description": "XML text. Default: · Maximum 100000 characters", "schema": { "type": "string", "default": "", "example": "", "maxLength": 100000 }, "example": "" } ], "x-actoki-response-fields": [ "json", "error" ] }, "post": { "tags": [ "Data Formatter API" ], "summary": "XML to JSON.", "operationId": "data_formatters_post_v1_data_xml_to_json", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "data_formatters", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "json": [], "error": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/data/xml-to-json.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "xml": { "type": "string", "default": "", "example": "", "maxLength": 100000, "description": "XML text. Default: · Maximum 100000 characters" } }, "additionalProperties": false }, "example": { "xml": "" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "xml": { "type": "string", "default": "", "example": "", "maxLength": 100000, "description": "XML text. Default: · Maximum 100000 characters" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "json", "error" ] } }, "/v1/data/flatten-json": { "get": { "tags": [ "Data Formatter API" ], "summary": "Flatten JSON.", "operationId": "data_formatters_get_v1_data_flatten_json", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "data_formatters", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "flattened": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/data/flatten-json.php", "parameters": [ { "name": "json", "in": "query", "required": false, "description": "JSON text. Default: {} · Maximum 100000 characters", "schema": { "type": "string", "default": "{}", "example": "{}", "maxLength": 100000 }, "example": "{}" } ], "x-actoki-response-fields": [ "flattened" ] }, "post": { "tags": [ "Data Formatter API" ], "summary": "Flatten JSON.", "operationId": "data_formatters_post_v1_data_flatten_json", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "data_formatters", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "flattened": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/data/flatten-json.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "json": { "type": "string", "default": "{}", "example": "{}", "maxLength": 100000, "description": "JSON text. Default: {} · Maximum 100000 characters" } }, "additionalProperties": false }, "example": { "json": "{}" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "json": { "type": "string", "default": "{}", "example": "{}", "maxLength": 100000, "description": "JSON text. Default: {} · Maximum 100000 characters" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "flattened" ] } }, "/v1/data-quality/dedupe": { "get": { "tags": [ "Data Quality API" ], "summary": "Remove duplicates", "operationId": "data_quality_get_v1_data_quality_dedupe", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "data_quality", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/data-quality/dedupe.php", "parameters": [ { "name": "text", "in": "query", "required": false, "description": "Text to process. Default: · Maximum 100000 characters", "schema": { "type": "string", "default": "", "example": "example", "maxLength": 100000 }, "example": "example" }, { "name": "items", "in": "query", "required": false, "description": "Array of input items. Default:", "schema": { "type": "string", "default": null, "example": "example" }, "example": "example" } ], "x-actoki-response-fields": [ "items" ] }, "post": { "tags": [ "Data Quality API" ], "summary": "Remove duplicates", "operationId": "data_quality_post_v1_data_quality_dedupe", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "data_quality", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/data-quality/dedupe.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "default": "", "example": "example", "maxLength": 100000, "description": "Text to process. Default: · Maximum 100000 characters" }, "items": { "type": "string", "default": null, "example": "example", "description": "Array of input items. Default:" } }, "additionalProperties": false }, "example": { "text": "example", "items": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "text": { "type": "string", "default": "", "example": "example", "maxLength": 100000, "description": "Text to process. Default: · Maximum 100000 characters" }, "items": { "type": "string", "default": null, "example": "example", "description": "Array of input items. Default:" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "items" ] } }, "/v1/data-quality/normalise": { "get": { "tags": [ "Data Quality API" ], "summary": "Normalise whitespace/casing", "operationId": "data_quality_get_v1_data_quality_normalise", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "data_quality", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/data-quality/normalise.php", "parameters": [ { "name": "text", "in": "query", "required": true, "description": "Text to process. Maximum 100000 characters", "schema": { "type": "string", "example": "example", "maxLength": 100000 }, "example": "example" } ], "x-actoki-response-fields": [ "text" ] }, "post": { "tags": [ "Data Quality API" ], "summary": "Normalise whitespace/casing", "operationId": "data_quality_post_v1_data_quality_normalise", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "data_quality", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/data-quality/normalise.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "example", "maxLength": 100000, "description": "Text to process. Maximum 100000 characters" } }, "additionalProperties": false, "required": [ "text" ] }, "example": { "text": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "example", "maxLength": 100000, "description": "Text to process. Maximum 100000 characters" } }, "additionalProperties": false, "required": [ "text" ] } } } }, "x-actoki-response-fields": [ "text" ] } }, "/v1/data-quality/fuzzy-match": { "get": { "tags": [ "Data Quality API" ], "summary": "Fuzzy match two values", "operationId": "data_quality_get_v1_data_quality_fuzzy_match", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "data_quality", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "match_percent": [], "is_likely_match": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/data-quality/fuzzy-match.php", "parameters": [ { "name": "a", "in": "query", "required": false, "description": "Request option: A. Default:", "schema": { "type": "string", "default": "", "example": "example" }, "example": "example" }, { "name": "b", "in": "query", "required": false, "description": "Request option: B. Default:", "schema": { "type": "string", "default": "", "example": "example" }, "example": "example" } ], "x-actoki-response-fields": [ "match_percent", "is_likely_match" ] }, "post": { "tags": [ "Data Quality API" ], "summary": "Fuzzy match two values", "operationId": "data_quality_post_v1_data_quality_fuzzy_match", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "data_quality", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "match_percent": [], "is_likely_match": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/data-quality/fuzzy-match.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "a": { "type": "string", "default": "", "example": "example", "description": "Request option: A. Default:" }, "b": { "type": "string", "default": "", "example": "example", "description": "Request option: B. Default:" } }, "additionalProperties": false }, "example": { "a": "example", "b": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "a": { "type": "string", "default": "", "example": "example", "description": "Request option: A. Default:" }, "b": { "type": "string", "default": "", "example": "example", "description": "Request option: B. Default:" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "match_percent", "is_likely_match" ] } }, "/v1/data-quality/name-split": { "get": { "tags": [ "Data Quality API" ], "summary": "Split a person name", "operationId": "data_quality_get_v1_data_quality_name_split", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "data_quality", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "first": [], "last": [], "parts": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/data-quality/name-split.php", "parameters": [ { "name": "name", "in": "query", "required": false, "description": "Human-readable name. Default:", "schema": { "type": "string", "default": "", "example": "example" }, "example": "example" } ], "x-actoki-response-fields": [ "first", "last", "parts" ] }, "post": { "tags": [ "Data Quality API" ], "summary": "Split a person name", "operationId": "data_quality_post_v1_data_quality_name_split", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "data_quality", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "first": [], "last": [], "parts": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/data-quality/name-split.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "default": "", "example": "example", "description": "Human-readable name. Default:" } }, "additionalProperties": false }, "example": { "name": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "name": { "type": "string", "default": "", "example": "example", "description": "Human-readable name. Default:" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "first", "last", "parts" ] } }, "/v1/data-quality/company-name-clean": { "get": { "tags": [ "Data Quality API" ], "summary": "Clean company suffixes", "operationId": "data_quality_get_v1_data_quality_company_name_clean", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "data_quality", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "clean_name": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/data-quality/company-name-clean.php", "parameters": [ { "name": "name", "in": "query", "required": false, "description": "Human-readable name. Default:", "schema": { "type": "string", "default": "", "example": "example" }, "example": "example" } ], "x-actoki-response-fields": [ "clean_name" ] }, "post": { "tags": [ "Data Quality API" ], "summary": "Clean company suffixes", "operationId": "data_quality_post_v1_data_quality_company_name_clean", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "data_quality", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "clean_name": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/data-quality/company-name-clean.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "default": "", "example": "example", "description": "Human-readable name. Default:" } }, "additionalProperties": false }, "example": { "name": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "name": { "type": "string", "default": "", "example": "example", "description": "Human-readable name. Default:" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "clean_name" ] } }, "/v1/design/palette/random": { "get": { "tags": [ "Design Tools API" ], "summary": "Generate 2-5 matching random colours.", "operationId": "design_tools_get_v1_design_palette_random", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "design_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/design/palette/random.php", "parameters": [ { "name": "count", "in": "query", "required": false, "description": "Request option: Count. Default: 5 · Min: 2 · Max: 5", "schema": { "type": "integer", "default": 5, "example": 5, "minimum": 2, "maximum": 5 }, "example": 5 }, { "name": "style", "in": "query", "required": false, "description": "Style key. Default: bright · Maximum 40 characters · Options: bright, pastel, pale, dark, monochrome", "schema": { "type": "string", "enum": [ "bright", "pastel", "pale", "dark", "monochrome" ], "default": "bright", "example": "bright", "maxLength": 40 }, "example": "bright" } ] }, "post": { "tags": [ "Design Tools API" ], "summary": "Generate 2-5 matching random colours.", "operationId": "design_tools_post_v1_design_palette_random", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "design_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/design/palette/random.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "default": 5, "example": 5, "minimum": 2, "maximum": 5, "description": "Request option: Count. Default: 5 · Min: 2 · Max: 5" }, "style": { "type": "string", "enum": [ "bright", "pastel", "pale", "dark", "monochrome" ], "default": "bright", "example": "bright", "maxLength": 40, "description": "Style key. Default: bright · Maximum 40 characters · Options: bright, pastel, pale, dark, monochrome" } }, "additionalProperties": false }, "example": { "count": 5, "style": "bright" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "default": 5, "example": 5, "minimum": 2, "maximum": 5, "description": "Request option: Count. Default: 5 · Min: 2 · Max: 5" }, "style": { "type": "string", "enum": [ "bright", "pastel", "pale", "dark", "monochrome" ], "default": "bright", "example": "bright", "maxLength": 40, "description": "Style key. Default: bright · Maximum 40 characters · Options: bright, pastel, pale, dark, monochrome" } }, "additionalProperties": false } } } } } }, "/v1/design/palette/from-colour": { "get": { "tags": [ "Design Tools API" ], "summary": "Generate matching colours from one colour.", "operationId": "design_tools_get_v1_design_palette_from_colour", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "design_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/design/palette/from-colour.php", "parameters": [ { "name": "colour", "in": "query", "required": false, "description": "Request option: Colour. Default: #3B82F6 · Maximum 20 characters", "schema": { "type": "string", "default": "#3B82F6", "example": "#3B82F6", "maxLength": 20 }, "example": "#3B82F6" }, { "name": "count", "in": "query", "required": false, "description": "Request option: Count. Default: 5 · Min: 2 · Max: 5", "schema": { "type": "integer", "default": 5, "example": 5, "minimum": 2, "maximum": 5 }, "example": 5 }, { "name": "style", "in": "query", "required": false, "description": "Style key. Default: bright · Maximum 40 characters · Options: bright, pastel, pale, dark, monochrome", "schema": { "type": "string", "enum": [ "bright", "pastel", "pale", "dark", "monochrome" ], "default": "bright", "example": "bright", "maxLength": 40 }, "example": "bright" } ] }, "post": { "tags": [ "Design Tools API" ], "summary": "Generate matching colours from one colour.", "operationId": "design_tools_post_v1_design_palette_from_colour", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "design_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/design/palette/from-colour.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "colour": { "type": "string", "default": "#3B82F6", "example": "#3B82F6", "maxLength": 20, "description": "Request option: Colour. Default: #3B82F6 · Maximum 20 characters" }, "count": { "type": "integer", "default": 5, "example": 5, "minimum": 2, "maximum": 5, "description": "Request option: Count. Default: 5 · Min: 2 · Max: 5" }, "style": { "type": "string", "enum": [ "bright", "pastel", "pale", "dark", "monochrome" ], "default": "bright", "example": "bright", "maxLength": 40, "description": "Style key. Default: bright · Maximum 40 characters · Options: bright, pastel, pale, dark, monochrome" } }, "additionalProperties": false }, "example": { "colour": "#3B82F6", "count": 5, "style": "bright" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "colour": { "type": "string", "default": "#3B82F6", "example": "#3B82F6", "maxLength": 20, "description": "Request option: Colour. Default: #3B82F6 · Maximum 20 characters" }, "count": { "type": "integer", "default": 5, "example": 5, "minimum": 2, "maximum": 5, "description": "Request option: Count. Default: 5 · Min: 2 · Max: 5" }, "style": { "type": "string", "enum": [ "bright", "pastel", "pale", "dark", "monochrome" ], "default": "bright", "example": "bright", "maxLength": 40, "description": "Style key. Default: bright · Maximum 40 characters · Options: bright, pastel, pale, dark, monochrome" } }, "additionalProperties": false } } } } } }, "/v1/design/colour/convert": { "get": { "tags": [ "Design Tools API" ], "summary": "Convert HEX/RGB/HSL colour formats.", "operationId": "design_tools_get_v1_design_colour_convert", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "design_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/design/colour/convert.php", "parameters": [ { "name": "colour", "in": "query", "required": false, "description": "Request option: Colour. Default: #3B82F6 · Maximum 20 characters", "schema": { "type": "string", "default": "#3B82F6", "example": "#3B82F6", "maxLength": 20 }, "example": "#3B82F6" } ] }, "post": { "tags": [ "Design Tools API" ], "summary": "Convert HEX/RGB/HSL colour formats.", "operationId": "design_tools_post_v1_design_colour_convert", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "design_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/design/colour/convert.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "colour": { "type": "string", "default": "#3B82F6", "example": "#3B82F6", "maxLength": 20, "description": "Request option: Colour. Default: #3B82F6 · Maximum 20 characters" } }, "additionalProperties": false }, "example": { "colour": "#3B82F6" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "colour": { "type": "string", "default": "#3B82F6", "example": "#3B82F6", "maxLength": 20, "description": "Request option: Colour. Default: #3B82F6 · Maximum 20 characters" } }, "additionalProperties": false } } } } } }, "/v1/design/colour/contrast": { "get": { "tags": [ "Design Tools API" ], "summary": "Check WCAG colour contrast.", "operationId": "design_tools_get_v1_design_colour_contrast", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "design_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "foreground": [], "background": [], "contrast_ratio": [], "wcag": [], "aa_normal": [], "aa_large": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/design/colour/contrast.php", "parameters": [ { "name": "foreground", "in": "query", "required": false, "description": "Request option: Foreground. Default: #111827 · Maximum 20 characters", "schema": { "type": "string", "default": "#111827", "example": "#111827", "maxLength": 20 }, "example": "#111827" }, { "name": "background", "in": "query", "required": false, "description": "Request option: Background. Default: #fff · Maximum 20 characters", "schema": { "type": "string", "default": "#fff", "example": "#fff", "maxLength": 20 }, "example": "#fff" } ], "x-actoki-response-fields": [ "foreground", "background", "contrast_ratio", "wcag", "aa_normal", "aa_large" ] }, "post": { "tags": [ "Design Tools API" ], "summary": "Check WCAG colour contrast.", "operationId": "design_tools_post_v1_design_colour_contrast", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "design_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "foreground": [], "background": [], "contrast_ratio": [], "wcag": [], "aa_normal": [], "aa_large": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/design/colour/contrast.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "foreground": { "type": "string", "default": "#111827", "example": "#111827", "maxLength": 20, "description": "Request option: Foreground. Default: #111827 · Maximum 20 characters" }, "background": { "type": "string", "default": "#fff", "example": "#fff", "maxLength": 20, "description": "Request option: Background. Default: #fff · Maximum 20 characters" } }, "additionalProperties": false }, "example": { "foreground": "#111827", "background": "#fff" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "foreground": { "type": "string", "default": "#111827", "example": "#111827", "maxLength": 20, "description": "Request option: Foreground. Default: #111827 · Maximum 20 characters" }, "background": { "type": "string", "default": "#fff", "example": "#fff", "maxLength": 20, "description": "Request option: Background. Default: #fff · Maximum 20 characters" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "foreground", "background", "contrast_ratio", "wcag", "aa_normal", "aa_large" ] } }, "/v1/design/gradient": { "get": { "tags": [ "Design Tools API" ], "summary": "Generate CSS gradients.", "operationId": "design_tools_get_v1_design_gradient", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "design_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "from": [], "to": [], "css": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/design/gradient.php", "parameters": [ { "name": "from", "in": "query", "required": false, "description": "Request option: From. Default: #3B82F6 · Maximum 20 characters", "schema": { "type": "string", "default": "#3B82F6", "example": "#3B82F6", "maxLength": 20 }, "example": "#3B82F6" }, { "name": "to", "in": "query", "required": false, "description": "Request option: To. Default: #22C55E · Maximum 20 characters", "schema": { "type": "string", "default": "#22C55E", "example": "#22C55E", "maxLength": 20 }, "example": "#22C55E" }, { "name": "direction", "in": "query", "required": false, "description": "Request option: Direction. Default: 90deg · Maximum 20 characters", "schema": { "type": "string", "default": "90deg", "example": "90deg", "maxLength": 20 }, "example": "90deg" } ], "x-actoki-response-fields": [ "from", "to", "css" ] }, "post": { "tags": [ "Design Tools API" ], "summary": "Generate CSS gradients.", "operationId": "design_tools_post_v1_design_gradient", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "design_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "from": [], "to": [], "css": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/design/gradient.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "from": { "type": "string", "default": "#3B82F6", "example": "#3B82F6", "maxLength": 20, "description": "Request option: From. Default: #3B82F6 · Maximum 20 characters" }, "to": { "type": "string", "default": "#22C55E", "example": "#22C55E", "maxLength": 20, "description": "Request option: To. Default: #22C55E · Maximum 20 characters" }, "direction": { "type": "string", "default": "90deg", "example": "90deg", "maxLength": 20, "description": "Request option: Direction. Default: 90deg · Maximum 20 characters" } }, "additionalProperties": false }, "example": { "from": "#3B82F6", "to": "#22C55E", "direction": "90deg" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "from": { "type": "string", "default": "#3B82F6", "example": "#3B82F6", "maxLength": 20, "description": "Request option: From. Default: #3B82F6 · Maximum 20 characters" }, "to": { "type": "string", "default": "#22C55E", "example": "#22C55E", "maxLength": 20, "description": "Request option: To. Default: #22C55E · Maximum 20 characters" }, "direction": { "type": "string", "default": "90deg", "example": "90deg", "maxLength": 20, "description": "Request option: Direction. Default: 90deg · Maximum 20 characters" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "from", "to", "css" ] } }, "/v1/dev/uuid": { "get": { "tags": [ "Developer Tools API" ], "summary": "Generate UUID v4 values.", "operationId": "developer_tools_get_v1_dev_uuid", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "developer_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "uuids": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/dev/uuid.php", "parameters": [ { "name": "count", "in": "query", "required": false, "description": "Request option: Count. Default: 1 · Min: 1 · Max: 100", "schema": { "type": "integer", "default": 1, "example": 1, "minimum": 1, "maximum": 100 }, "example": 1 } ], "x-actoki-response-fields": [ "uuids" ] }, "post": { "tags": [ "Developer Tools API" ], "summary": "Generate UUID v4 values.", "operationId": "developer_tools_post_v1_dev_uuid", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "developer_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "uuids": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/dev/uuid.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "default": 1, "example": 1, "minimum": 1, "maximum": 100, "description": "Request option: Count. Default: 1 · Min: 1 · Max: 100" } }, "additionalProperties": false }, "example": { "count": 1 } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "default": 1, "example": 1, "minimum": 1, "maximum": 100, "description": "Request option: Count. Default: 1 · Min: 1 · Max: 100" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "uuids" ] } }, "/v1/dev/hash": { "get": { "tags": [ "Developer Tools API" ], "summary": "Hash text.", "operationId": "developer_tools_get_v1_dev_hash", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "developer_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": [], "algorithm": [], "hash": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/dev/hash.php", "parameters": [ { "name": "algorithm", "in": "query", "required": false, "description": "Request option: Algorithm. Default: sha256 · Maximum 40 characters", "schema": { "type": "string", "default": "sha256", "example": "sha256", "maxLength": 40 }, "example": "sha256" }, { "name": "text", "in": "query", "required": false, "description": "Text to process. Default: · Maximum 100000 characters", "schema": { "type": "string", "default": "", "example": "example", "maxLength": 100000 }, "example": "example" } ], "x-actoki-response-fields": [ "error", "algorithm", "hash" ] }, "post": { "tags": [ "Developer Tools API" ], "summary": "Hash text.", "operationId": "developer_tools_post_v1_dev_hash", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "developer_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": [], "algorithm": [], "hash": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/dev/hash.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "algorithm": { "type": "string", "default": "sha256", "example": "sha256", "maxLength": 40, "description": "Request option: Algorithm. Default: sha256 · Maximum 40 characters" }, "text": { "type": "string", "default": "", "example": "example", "maxLength": 100000, "description": "Text to process. Default: · Maximum 100000 characters" } }, "additionalProperties": false }, "example": { "algorithm": "sha256", "text": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "algorithm": { "type": "string", "default": "sha256", "example": "sha256", "maxLength": 40, "description": "Request option: Algorithm. Default: sha256 · Maximum 40 characters" }, "text": { "type": "string", "default": "", "example": "example", "maxLength": 100000, "description": "Text to process. Default: · Maximum 100000 characters" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "error", "algorithm", "hash" ] } }, "/v1/dev/base64/encode": { "get": { "tags": [ "Developer Tools API" ], "summary": "Base64 encode.", "operationId": "developer_tools_get_v1_dev_base64_encode", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "developer_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "encoded": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/dev/base64/encode.php", "parameters": [ { "name": "text", "in": "query", "required": false, "description": "Text to process. Default: · Maximum 100000 characters", "schema": { "type": "string", "default": "", "example": "example", "maxLength": 100000 }, "example": "example" } ], "x-actoki-response-fields": [ "encoded" ] }, "post": { "tags": [ "Developer Tools API" ], "summary": "Base64 encode.", "operationId": "developer_tools_post_v1_dev_base64_encode", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "developer_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "encoded": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/dev/base64/encode.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "default": "", "example": "example", "maxLength": 100000, "description": "Text to process. Default: · Maximum 100000 characters" } }, "additionalProperties": false }, "example": { "text": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "text": { "type": "string", "default": "", "example": "example", "maxLength": 100000, "description": "Text to process. Default: · Maximum 100000 characters" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "encoded" ] } }, "/v1/dev/base64/decode": { "get": { "tags": [ "Developer Tools API" ], "summary": "Base64 decode.", "operationId": "developer_tools_get_v1_dev_base64_decode", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "developer_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "decoded": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/dev/base64/decode.php", "parameters": [ { "name": "text", "in": "query", "required": false, "description": "Text to process. Default: · Maximum 100000 characters", "schema": { "type": "string", "default": "", "example": "example", "maxLength": 100000 }, "example": "example" } ], "x-actoki-response-fields": [ "decoded" ] }, "post": { "tags": [ "Developer Tools API" ], "summary": "Base64 decode.", "operationId": "developer_tools_post_v1_dev_base64_decode", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "developer_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "decoded": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/dev/base64/decode.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "default": "", "example": "example", "maxLength": 100000, "description": "Text to process. Default: · Maximum 100000 characters" } }, "additionalProperties": false }, "example": { "text": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "text": { "type": "string", "default": "", "example": "example", "maxLength": 100000, "description": "Text to process. Default: · Maximum 100000 characters" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "decoded" ] } }, "/v1/dev/json/validate": { "get": { "tags": [ "Developer Tools API" ], "summary": "Validate JSON.", "operationId": "developer_tools_get_v1_dev_json_validate", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "developer_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": [], "error": [], "formatted": [], "data": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/dev/json/validate.php", "parameters": [ { "name": "json", "in": "query", "required": false, "description": "JSON text. Default: · Maximum 100000 characters", "schema": { "type": "string", "default": "", "example": "example", "maxLength": 100000 }, "example": "example" } ], "x-actoki-response-fields": [ "valid", "error", "formatted", "data" ] }, "post": { "tags": [ "Developer Tools API" ], "summary": "Validate JSON.", "operationId": "developer_tools_post_v1_dev_json_validate", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "developer_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": [], "error": [], "formatted": [], "data": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/dev/json/validate.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "json": { "type": "string", "default": "", "example": "example", "maxLength": 100000, "description": "JSON text. Default: · Maximum 100000 characters" } }, "additionalProperties": false }, "example": { "json": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "json": { "type": "string", "default": "", "example": "example", "maxLength": 100000, "description": "JSON text. Default: · Maximum 100000 characters" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "valid", "error", "formatted", "data" ] } }, "/v1/dev/json/format": { "get": { "tags": [ "Developer Tools API" ], "summary": "Format JSON.", "operationId": "developer_tools_get_v1_dev_json_format", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "developer_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": [], "error": [], "formatted": [], "data": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/dev/json/format.php", "parameters": [ { "name": "json", "in": "query", "required": false, "description": "JSON text. Default: · Maximum 100000 characters", "schema": { "type": "string", "default": "", "example": "example", "maxLength": 100000 }, "example": "example" } ], "x-actoki-response-fields": [ "valid", "error", "formatted", "data" ] }, "post": { "tags": [ "Developer Tools API" ], "summary": "Format JSON.", "operationId": "developer_tools_post_v1_dev_json_format", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "developer_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": [], "error": [], "formatted": [], "data": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/dev/json/format.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "json": { "type": "string", "default": "", "example": "example", "maxLength": 100000, "description": "JSON text. Default: · Maximum 100000 characters" } }, "additionalProperties": false }, "example": { "json": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "json": { "type": "string", "default": "", "example": "example", "maxLength": 100000, "description": "JSON text. Default: · Maximum 100000 characters" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "valid", "error", "formatted", "data" ] } }, "/v1/dev/jwt/decode": { "get": { "tags": [ "Developer Tools API" ], "summary": "Decode JWT.", "operationId": "developer_tools_get_v1_dev_jwt_decode", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "developer_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": [], "error": [], "header": [], "payload": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/dev/jwt/decode.php", "parameters": [ { "name": "jwt", "in": "query", "required": false, "description": "Request option: Jwt. Default: · Maximum 20000 characters", "schema": { "type": "string", "default": "", "example": "example", "maxLength": 20000 }, "example": "example" } ], "x-actoki-response-fields": [ "valid", "error", "header", "payload" ] }, "post": { "tags": [ "Developer Tools API" ], "summary": "Decode JWT.", "operationId": "developer_tools_post_v1_dev_jwt_decode", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "developer_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": [], "error": [], "header": [], "payload": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/dev/jwt/decode.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "jwt": { "type": "string", "default": "", "example": "example", "maxLength": 20000, "description": "Request option: Jwt. Default: · Maximum 20000 characters" } }, "additionalProperties": false }, "example": { "jwt": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "jwt": { "type": "string", "default": "", "example": "example", "maxLength": 20000, "description": "Request option: Jwt. Default: · Maximum 20000 characters" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "valid", "error", "header", "payload" ] } }, "/v1/dev/regex/test": { "get": { "tags": [ "Developer Tools API" ], "summary": "Test regex.", "operationId": "developer_tools_get_v1_dev_regex_test", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "developer_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": [], "matched": [], "matches": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/dev/regex/test.php", "parameters": [ { "name": "pattern", "in": "query", "required": false, "description": "Request option: Pattern. Default: // · Maximum 1000 characters", "schema": { "type": "string", "default": "//", "example": "//", "maxLength": 1000 }, "example": "//" }, { "name": "text", "in": "query", "required": false, "description": "Text to process. Default: · Maximum 100000 characters", "schema": { "type": "string", "default": "", "example": "example", "maxLength": 100000 }, "example": "example" } ], "x-actoki-response-fields": [ "valid", "matched", "matches" ] }, "post": { "tags": [ "Developer Tools API" ], "summary": "Test regex.", "operationId": "developer_tools_post_v1_dev_regex_test", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "developer_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": [], "matched": [], "matches": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/dev/regex/test.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "pattern": { "type": "string", "default": "//", "example": "//", "maxLength": 1000, "description": "Request option: Pattern. Default: // · Maximum 1000 characters" }, "text": { "type": "string", "default": "", "example": "example", "maxLength": 100000, "description": "Text to process. Default: · Maximum 100000 characters" } }, "additionalProperties": false }, "example": { "pattern": "//", "text": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "pattern": { "type": "string", "default": "//", "example": "//", "maxLength": 1000, "description": "Request option: Pattern. Default: // · Maximum 1000 characters" }, "text": { "type": "string", "default": "", "example": "example", "maxLength": 100000, "description": "Text to process. Default: · Maximum 100000 characters" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "valid", "matched", "matches" ] } }, "/v1/dev/url/parse": { "get": { "tags": [ "Developer Tools API" ], "summary": "Parse URL.", "operationId": "developer_tools_get_v1_dev_url_parse", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "developer_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "parts": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/dev/url/parse.php", "parameters": [ { "name": "url", "in": "query", "required": false, "description": "Absolute HTTP or HTTPS URL. Default: · Maximum 2000 characters", "schema": { "type": "string", "default": "", "example": "https://example.com", "maxLength": 2000 }, "example": "https://example.com" } ], "x-actoki-response-fields": [ "parts" ] }, "post": { "tags": [ "Developer Tools API" ], "summary": "Parse URL.", "operationId": "developer_tools_post_v1_dev_url_parse", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "developer_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "parts": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/dev/url/parse.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "default": "", "example": "https://example.com", "maxLength": 2000, "description": "Absolute HTTP or HTTPS URL. Default: · Maximum 2000 characters" } }, "additionalProperties": false }, "example": { "url": "https://example.com" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "url": { "type": "string", "default": "", "example": "https://example.com", "maxLength": 2000, "description": "Absolute HTTP or HTTPS URL. Default: · Maximum 2000 characters" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "parts" ] } }, "/v1/document/extract-tables": { "get": { "tags": [ "Document OCR & Extraction API" ], "summary": "Extract table-like rows", "operationId": "document_extraction_get_v1_document_extract_tables", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "document_extraction", "x-actoki-units": 25, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": [], "row_count": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/document/extract-tables.php", "parameters": [ { "name": "text", "in": "query", "required": true, "description": "Text to process. Maximum 200000 characters", "schema": { "type": "string", "example": "example", "maxLength": 200000 }, "example": "example" } ], "x-actoki-response-fields": [ "rows", "row_count" ] }, "post": { "tags": [ "Document OCR & Extraction API" ], "summary": "Extract table-like rows", "operationId": "document_extraction_post_v1_document_extract_tables", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "document_extraction", "x-actoki-units": 25, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": [], "row_count": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/document/extract-tables.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "example", "maxLength": 200000, "description": "Text to process. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "text" ] }, "example": { "text": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "example", "maxLength": 200000, "description": "Text to process. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "text" ] } } } }, "x-actoki-response-fields": [ "rows", "row_count" ] } }, "/v1/document/invoice-read": { "get": { "tags": [ "Document OCR & Extraction API" ], "summary": "Read invoice fields", "operationId": "document_extraction_get_v1_document_invoice_read", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "document_extraction", "x-actoki-units": 25, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "document_type": [], "reference": [], "total": [], "confidence": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/document/invoice-read.php", "parameters": [ { "name": "text", "in": "query", "required": true, "description": "Text to process. Maximum 200000 characters", "schema": { "type": "string", "example": "example", "maxLength": 200000 }, "example": "example" } ], "x-actoki-response-fields": [ "document_type", "reference", "total", "confidence" ] }, "post": { "tags": [ "Document OCR & Extraction API" ], "summary": "Read invoice fields", "operationId": "document_extraction_post_v1_document_invoice_read", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "document_extraction", "x-actoki-units": 25, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "document_type": [], "reference": [], "total": [], "confidence": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/document/invoice-read.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "example", "maxLength": 200000, "description": "Text to process. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "text" ] }, "example": { "text": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "example", "maxLength": 200000, "description": "Text to process. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "text" ] } } } }, "x-actoki-response-fields": [ "document_type", "reference", "total", "confidence" ] } }, "/v1/document/receipt-read": { "get": { "tags": [ "Document OCR & Extraction API" ], "summary": "Read receipt fields", "operationId": "document_extraction_get_v1_document_receipt_read", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "document_extraction", "x-actoki-units": 25, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "document_type": [], "reference": [], "total": [], "confidence": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/document/receipt-read.php", "parameters": [ { "name": "text", "in": "query", "required": true, "description": "Text to process. Maximum 200000 characters", "schema": { "type": "string", "example": "example", "maxLength": 200000 }, "example": "example" } ], "x-actoki-response-fields": [ "document_type", "reference", "total", "confidence" ] }, "post": { "tags": [ "Document OCR & Extraction API" ], "summary": "Read receipt fields", "operationId": "document_extraction_post_v1_document_receipt_read", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "document_extraction", "x-actoki-units": 25, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "document_type": [], "reference": [], "total": [], "confidence": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/document/receipt-read.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "example", "maxLength": 200000, "description": "Text to process. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "text" ] }, "example": { "text": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "example", "maxLength": 200000, "description": "Text to process. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "text" ] } } } }, "x-actoki-response-fields": [ "document_type", "reference", "total", "confidence" ] } }, "/v1/document/passport-mrz": { "get": { "tags": [ "Document OCR & Extraction API" ], "summary": "Parse passport MRZ", "operationId": "document_extraction_get_v1_document_passport_mrz", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "document_extraction", "x-actoki-units": 25, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/document/passport-mrz.php", "parameters": [ { "name": "mrz", "in": "query", "required": true, "description": "Passport machine-readable zone text. Maximum 200 characters", "schema": { "type": "string", "example": "PActoki Document

Generated by Actoki PDF API.

· Maximum 200000 characters", "schema": { "type": "string", "default": "

Actoki Document

Generated by Actoki PDF API.

", "example": "

Actoki Document

Generated by Actoki PDF API.

", "maxLength": 200000 }, "example": "

Actoki Document

Generated by Actoki PDF API.

" }, { "name": "invoice_number", "in": "query", "required": false, "description": "Request option: Invoice Number. Default: INV-TEST · Maximum 80 characters", "schema": { "type": "string", "default": "INV-TEST", "example": "INV-TEST", "maxLength": 80 }, "example": "INV-TEST" }, { "name": "amount", "in": "query", "required": false, "description": "Request option: Amount. Default: 0.00 · Maximum 40 characters", "schema": { "type": "string", "default": "0.00", "example": "0.00", "maxLength": 40 }, "example": "0.00" }, { "name": "engine", "in": "query", "required": true, "description": "Request option: Engine. Maximum 30 characters", "schema": { "type": "string", "example": "example", "maxLength": 30 }, "example": "example" }, { "name": "output", "in": "query", "required": false, "description": "Request option: Output. Default: base64 · Maximum 20 characters · Options: base64, download", "schema": { "type": "string", "enum": [ "base64", "download" ], "default": "base64", "example": "base64", "maxLength": 20 }, "example": "base64" }, { "name": "filename", "in": "query", "required": true, "description": "Request option: Filename. Maximum 120 characters", "schema": { "type": "string", "example": "example", "maxLength": 120 }, "example": "example" }, { "name": "paper", "in": "query", "required": false, "description": "Request option: Paper. Default: A4 · Maximum 20 characters · Options: A4, A3, Letter, Legal", "schema": { "type": "string", "enum": [ "A4", "A3", "Letter", "Legal" ], "default": "A4", "example": "A4", "maxLength": 20 }, "example": "A4" }, { "name": "orientation", "in": "query", "required": false, "description": "Request option: Orientation. Default: portrait · Maximum 20 characters · Options: portrait, landscape", "schema": { "type": "string", "enum": [ "portrait", "landscape" ], "default": "portrait", "example": "portrait", "maxLength": 20 }, "example": "portrait" } ], "x-actoki-response-fields": [ "operation", "engine", "output", "filename", "paper", "orientation", "remote", "provider_ready", "note", "html" ] }, "post": { "tags": [ "PDF / Document API" ], "summary": "Generate PDF from HTML.", "operationId": "pdf_documents_post_v1_pdf_from_html", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "pdf_documents", "x-actoki-units": 25, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "operation": [], "engine": [], "output": [], "filename": [], "paper": [], "orientation": [], "remote": [], "provider_ready": [], "note": [], "html": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/pdf/from-html.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "html": { "type": "string", "default": "

Actoki Document

Generated by Actoki PDF API.

", "example": "

Actoki Document

Generated by Actoki PDF API.

", "maxLength": 200000, "description": "HTML content to process. Default:

Actoki Document

Generated by Actoki PDF API.

· Maximum 200000 characters" }, "invoice_number": { "type": "string", "default": "INV-TEST", "example": "INV-TEST", "maxLength": 80, "description": "Request option: Invoice Number. Default: INV-TEST · Maximum 80 characters" }, "amount": { "type": "string", "default": "0.00", "example": "0.00", "maxLength": 40, "description": "Request option: Amount. Default: 0.00 · Maximum 40 characters" }, "engine": { "type": "string", "example": "example", "maxLength": 30, "description": "Request option: Engine. Maximum 30 characters" }, "output": { "type": "string", "enum": [ "base64", "download" ], "default": "base64", "example": "base64", "maxLength": 20, "description": "Request option: Output. Default: base64 · Maximum 20 characters · Options: base64, download" }, "filename": { "type": "string", "example": "example", "maxLength": 120, "description": "Request option: Filename. Maximum 120 characters" }, "paper": { "type": "string", "enum": [ "A4", "A3", "Letter", "Legal" ], "default": "A4", "example": "A4", "maxLength": 20, "description": "Request option: Paper. Default: A4 · Maximum 20 characters · Options: A4, A3, Letter, Legal" }, "orientation": { "type": "string", "enum": [ "portrait", "landscape" ], "default": "portrait", "example": "portrait", "maxLength": 20, "description": "Request option: Orientation. Default: portrait · Maximum 20 characters · Options: portrait, landscape" } }, "additionalProperties": false, "required": [ "engine", "filename" ] }, "example": { "html": "

Actoki Document

Generated by Actoki PDF API.

", "invoice_number": "INV-TEST", "amount": "0.00", "engine": "example", "filename": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "html": { "type": "string", "default": "

Actoki Document

Generated by Actoki PDF API.

", "example": "

Actoki Document

Generated by Actoki PDF API.

", "maxLength": 200000, "description": "HTML content to process. Default:

Actoki Document

Generated by Actoki PDF API.

· Maximum 200000 characters" }, "invoice_number": { "type": "string", "default": "INV-TEST", "example": "INV-TEST", "maxLength": 80, "description": "Request option: Invoice Number. Default: INV-TEST · Maximum 80 characters" }, "amount": { "type": "string", "default": "0.00", "example": "0.00", "maxLength": 40, "description": "Request option: Amount. Default: 0.00 · Maximum 40 characters" }, "engine": { "type": "string", "example": "example", "maxLength": 30, "description": "Request option: Engine. Maximum 30 characters" }, "output": { "type": "string", "enum": [ "base64", "download" ], "default": "base64", "example": "base64", "maxLength": 20, "description": "Request option: Output. Default: base64 · Maximum 20 characters · Options: base64, download" }, "filename": { "type": "string", "example": "example", "maxLength": 120, "description": "Request option: Filename. Maximum 120 characters" }, "paper": { "type": "string", "enum": [ "A4", "A3", "Letter", "Legal" ], "default": "A4", "example": "A4", "maxLength": 20, "description": "Request option: Paper. Default: A4 · Maximum 20 characters · Options: A4, A3, Letter, Legal" }, "orientation": { "type": "string", "enum": [ "portrait", "landscape" ], "default": "portrait", "example": "portrait", "maxLength": 20, "description": "Request option: Orientation. Default: portrait · Maximum 20 characters · Options: portrait, landscape" } }, "additionalProperties": false, "required": [ "engine", "filename" ] } } } }, "x-actoki-response-fields": [ "operation", "engine", "output", "filename", "paper", "orientation", "remote", "provider_ready", "note", "html" ] } }, "/v1/pdf/invoice": { "get": { "tags": [ "PDF / Document API" ], "summary": "Generate invoice PDF.", "operationId": "pdf_documents_get_v1_pdf_invoice", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "pdf_documents", "x-actoki-units": 25, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "operation": [], "engine": [], "output": [], "filename": [], "paper": [], "orientation": [], "remote": [], "provider_ready": [], "note": [], "html": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/pdf/invoice.php", "parameters": [ { "name": "html", "in": "query", "required": false, "description": "HTML content to process. Default:

Actoki Document

Generated by Actoki PDF API.

· Maximum 200000 characters", "schema": { "type": "string", "default": "

Actoki Document

Generated by Actoki PDF API.

", "example": "

Actoki Document

Generated by Actoki PDF API.

", "maxLength": 200000 }, "example": "

Actoki Document

Generated by Actoki PDF API.

" }, { "name": "invoice_number", "in": "query", "required": false, "description": "Request option: Invoice Number. Default: INV-TEST · Maximum 80 characters", "schema": { "type": "string", "default": "INV-TEST", "example": "INV-TEST", "maxLength": 80 }, "example": "INV-TEST" }, { "name": "amount", "in": "query", "required": false, "description": "Request option: Amount. Default: 0.00 · Maximum 40 characters", "schema": { "type": "string", "default": "0.00", "example": "0.00", "maxLength": 40 }, "example": "0.00" }, { "name": "engine", "in": "query", "required": true, "description": "Request option: Engine. Maximum 30 characters", "schema": { "type": "string", "example": "example", "maxLength": 30 }, "example": "example" }, { "name": "output", "in": "query", "required": false, "description": "Request option: Output. Default: base64 · Maximum 20 characters · Options: base64, download", "schema": { "type": "string", "enum": [ "base64", "download" ], "default": "base64", "example": "base64", "maxLength": 20 }, "example": "base64" }, { "name": "filename", "in": "query", "required": true, "description": "Request option: Filename. Maximum 120 characters", "schema": { "type": "string", "example": "example", "maxLength": 120 }, "example": "example" }, { "name": "paper", "in": "query", "required": false, "description": "Request option: Paper. Default: A4 · Maximum 20 characters · Options: A4, A3, Letter, Legal", "schema": { "type": "string", "enum": [ "A4", "A3", "Letter", "Legal" ], "default": "A4", "example": "A4", "maxLength": 20 }, "example": "A4" }, { "name": "orientation", "in": "query", "required": false, "description": "Request option: Orientation. Default: portrait · Maximum 20 characters · Options: portrait, landscape", "schema": { "type": "string", "enum": [ "portrait", "landscape" ], "default": "portrait", "example": "portrait", "maxLength": 20 }, "example": "portrait" } ], "x-actoki-response-fields": [ "operation", "engine", "output", "filename", "paper", "orientation", "remote", "provider_ready", "note", "html" ] }, "post": { "tags": [ "PDF / Document API" ], "summary": "Generate invoice PDF.", "operationId": "pdf_documents_post_v1_pdf_invoice", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "pdf_documents", "x-actoki-units": 25, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "operation": [], "engine": [], "output": [], "filename": [], "paper": [], "orientation": [], "remote": [], "provider_ready": [], "note": [], "html": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/pdf/invoice.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "html": { "type": "string", "default": "

Actoki Document

Generated by Actoki PDF API.

", "example": "

Actoki Document

Generated by Actoki PDF API.

", "maxLength": 200000, "description": "HTML content to process. Default:

Actoki Document

Generated by Actoki PDF API.

· Maximum 200000 characters" }, "invoice_number": { "type": "string", "default": "INV-TEST", "example": "INV-TEST", "maxLength": 80, "description": "Request option: Invoice Number. Default: INV-TEST · Maximum 80 characters" }, "amount": { "type": "string", "default": "0.00", "example": "0.00", "maxLength": 40, "description": "Request option: Amount. Default: 0.00 · Maximum 40 characters" }, "engine": { "type": "string", "example": "example", "maxLength": 30, "description": "Request option: Engine. Maximum 30 characters" }, "output": { "type": "string", "enum": [ "base64", "download" ], "default": "base64", "example": "base64", "maxLength": 20, "description": "Request option: Output. Default: base64 · Maximum 20 characters · Options: base64, download" }, "filename": { "type": "string", "example": "example", "maxLength": 120, "description": "Request option: Filename. Maximum 120 characters" }, "paper": { "type": "string", "enum": [ "A4", "A3", "Letter", "Legal" ], "default": "A4", "example": "A4", "maxLength": 20, "description": "Request option: Paper. Default: A4 · Maximum 20 characters · Options: A4, A3, Letter, Legal" }, "orientation": { "type": "string", "enum": [ "portrait", "landscape" ], "default": "portrait", "example": "portrait", "maxLength": 20, "description": "Request option: Orientation. Default: portrait · Maximum 20 characters · Options: portrait, landscape" } }, "additionalProperties": false, "required": [ "engine", "filename" ] }, "example": { "html": "

Actoki Document

Generated by Actoki PDF API.

", "invoice_number": "INV-TEST", "amount": "0.00", "engine": "example", "filename": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "html": { "type": "string", "default": "

Actoki Document

Generated by Actoki PDF API.

", "example": "

Actoki Document

Generated by Actoki PDF API.

", "maxLength": 200000, "description": "HTML content to process. Default:

Actoki Document

Generated by Actoki PDF API.

· Maximum 200000 characters" }, "invoice_number": { "type": "string", "default": "INV-TEST", "example": "INV-TEST", "maxLength": 80, "description": "Request option: Invoice Number. Default: INV-TEST · Maximum 80 characters" }, "amount": { "type": "string", "default": "0.00", "example": "0.00", "maxLength": 40, "description": "Request option: Amount. Default: 0.00 · Maximum 40 characters" }, "engine": { "type": "string", "example": "example", "maxLength": 30, "description": "Request option: Engine. Maximum 30 characters" }, "output": { "type": "string", "enum": [ "base64", "download" ], "default": "base64", "example": "base64", "maxLength": 20, "description": "Request option: Output. Default: base64 · Maximum 20 characters · Options: base64, download" }, "filename": { "type": "string", "example": "example", "maxLength": 120, "description": "Request option: Filename. Maximum 120 characters" }, "paper": { "type": "string", "enum": [ "A4", "A3", "Letter", "Legal" ], "default": "A4", "example": "A4", "maxLength": 20, "description": "Request option: Paper. Default: A4 · Maximum 20 characters · Options: A4, A3, Letter, Legal" }, "orientation": { "type": "string", "enum": [ "portrait", "landscape" ], "default": "portrait", "example": "portrait", "maxLength": 20, "description": "Request option: Orientation. Default: portrait · Maximum 20 characters · Options: portrait, landscape" } }, "additionalProperties": false, "required": [ "engine", "filename" ] } } } }, "x-actoki-response-fields": [ "operation", "engine", "output", "filename", "paper", "orientation", "remote", "provider_ready", "note", "html" ] } }, "/v1/pdf/merge": { "get": { "tags": [ "PDF / Document API" ], "summary": "Merge PDFs.", "operationId": "pdf_documents_get_v1_pdf_merge", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "pdf_documents", "x-actoki-units": 25, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "operation": [], "engine": [], "output": [], "filename": [], "paper": [], "orientation": [], "remote": [], "provider_ready": [], "note": [], "html": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/pdf/merge.php", "parameters": [ { "name": "html", "in": "query", "required": false, "description": "HTML content to process. Default:

Actoki Document

Generated by Actoki PDF API.

· Maximum 200000 characters", "schema": { "type": "string", "default": "

Actoki Document

Generated by Actoki PDF API.

", "example": "

Actoki Document

Generated by Actoki PDF API.

", "maxLength": 200000 }, "example": "

Actoki Document

Generated by Actoki PDF API.

" }, { "name": "invoice_number", "in": "query", "required": false, "description": "Request option: Invoice Number. Default: INV-TEST · Maximum 80 characters", "schema": { "type": "string", "default": "INV-TEST", "example": "INV-TEST", "maxLength": 80 }, "example": "INV-TEST" }, { "name": "amount", "in": "query", "required": false, "description": "Request option: Amount. Default: 0.00 · Maximum 40 characters", "schema": { "type": "string", "default": "0.00", "example": "0.00", "maxLength": 40 }, "example": "0.00" }, { "name": "engine", "in": "query", "required": true, "description": "Request option: Engine. Maximum 30 characters", "schema": { "type": "string", "example": "example", "maxLength": 30 }, "example": "example" }, { "name": "output", "in": "query", "required": false, "description": "Request option: Output. Default: base64 · Maximum 20 characters · Options: base64, download", "schema": { "type": "string", "enum": [ "base64", "download" ], "default": "base64", "example": "base64", "maxLength": 20 }, "example": "base64" }, { "name": "filename", "in": "query", "required": true, "description": "Request option: Filename. Maximum 120 characters", "schema": { "type": "string", "example": "example", "maxLength": 120 }, "example": "example" }, { "name": "paper", "in": "query", "required": false, "description": "Request option: Paper. Default: A4 · Maximum 20 characters · Options: A4, A3, Letter, Legal", "schema": { "type": "string", "enum": [ "A4", "A3", "Letter", "Legal" ], "default": "A4", "example": "A4", "maxLength": 20 }, "example": "A4" }, { "name": "orientation", "in": "query", "required": false, "description": "Request option: Orientation. Default: portrait · Maximum 20 characters · Options: portrait, landscape", "schema": { "type": "string", "enum": [ "portrait", "landscape" ], "default": "portrait", "example": "portrait", "maxLength": 20 }, "example": "portrait" } ], "x-actoki-response-fields": [ "operation", "engine", "output", "filename", "paper", "orientation", "remote", "provider_ready", "note", "html" ] }, "post": { "tags": [ "PDF / Document API" ], "summary": "Merge PDFs.", "operationId": "pdf_documents_post_v1_pdf_merge", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "pdf_documents", "x-actoki-units": 25, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "operation": [], "engine": [], "output": [], "filename": [], "paper": [], "orientation": [], "remote": [], "provider_ready": [], "note": [], "html": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/pdf/merge.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "html": { "type": "string", "default": "

Actoki Document

Generated by Actoki PDF API.

", "example": "

Actoki Document

Generated by Actoki PDF API.

", "maxLength": 200000, "description": "HTML content to process. Default:

Actoki Document

Generated by Actoki PDF API.

· Maximum 200000 characters" }, "invoice_number": { "type": "string", "default": "INV-TEST", "example": "INV-TEST", "maxLength": 80, "description": "Request option: Invoice Number. Default: INV-TEST · Maximum 80 characters" }, "amount": { "type": "string", "default": "0.00", "example": "0.00", "maxLength": 40, "description": "Request option: Amount. Default: 0.00 · Maximum 40 characters" }, "engine": { "type": "string", "example": "example", "maxLength": 30, "description": "Request option: Engine. Maximum 30 characters" }, "output": { "type": "string", "enum": [ "base64", "download" ], "default": "base64", "example": "base64", "maxLength": 20, "description": "Request option: Output. Default: base64 · Maximum 20 characters · Options: base64, download" }, "filename": { "type": "string", "example": "example", "maxLength": 120, "description": "Request option: Filename. Maximum 120 characters" }, "paper": { "type": "string", "enum": [ "A4", "A3", "Letter", "Legal" ], "default": "A4", "example": "A4", "maxLength": 20, "description": "Request option: Paper. Default: A4 · Maximum 20 characters · Options: A4, A3, Letter, Legal" }, "orientation": { "type": "string", "enum": [ "portrait", "landscape" ], "default": "portrait", "example": "portrait", "maxLength": 20, "description": "Request option: Orientation. Default: portrait · Maximum 20 characters · Options: portrait, landscape" } }, "additionalProperties": false, "required": [ "engine", "filename" ] }, "example": { "html": "

Actoki Document

Generated by Actoki PDF API.

", "invoice_number": "INV-TEST", "amount": "0.00", "engine": "example", "filename": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "html": { "type": "string", "default": "

Actoki Document

Generated by Actoki PDF API.

", "example": "

Actoki Document

Generated by Actoki PDF API.

", "maxLength": 200000, "description": "HTML content to process. Default:

Actoki Document

Generated by Actoki PDF API.

· Maximum 200000 characters" }, "invoice_number": { "type": "string", "default": "INV-TEST", "example": "INV-TEST", "maxLength": 80, "description": "Request option: Invoice Number. Default: INV-TEST · Maximum 80 characters" }, "amount": { "type": "string", "default": "0.00", "example": "0.00", "maxLength": 40, "description": "Request option: Amount. Default: 0.00 · Maximum 40 characters" }, "engine": { "type": "string", "example": "example", "maxLength": 30, "description": "Request option: Engine. Maximum 30 characters" }, "output": { "type": "string", "enum": [ "base64", "download" ], "default": "base64", "example": "base64", "maxLength": 20, "description": "Request option: Output. Default: base64 · Maximum 20 characters · Options: base64, download" }, "filename": { "type": "string", "example": "example", "maxLength": 120, "description": "Request option: Filename. Maximum 120 characters" }, "paper": { "type": "string", "enum": [ "A4", "A3", "Letter", "Legal" ], "default": "A4", "example": "A4", "maxLength": 20, "description": "Request option: Paper. Default: A4 · Maximum 20 characters · Options: A4, A3, Letter, Legal" }, "orientation": { "type": "string", "enum": [ "portrait", "landscape" ], "default": "portrait", "example": "portrait", "maxLength": 20, "description": "Request option: Orientation. Default: portrait · Maximum 20 characters · Options: portrait, landscape" } }, "additionalProperties": false, "required": [ "engine", "filename" ] } } } }, "x-actoki-response-fields": [ "operation", "engine", "output", "filename", "paper", "orientation", "remote", "provider_ready", "note", "html" ] } }, "/v1/pdf/split": { "get": { "tags": [ "PDF / Document API" ], "summary": "Split PDFs.", "operationId": "pdf_documents_get_v1_pdf_split", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "pdf_documents", "x-actoki-units": 25, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "operation": [], "engine": [], "output": [], "filename": [], "paper": [], "orientation": [], "remote": [], "provider_ready": [], "note": [], "html": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/pdf/split.php", "parameters": [ { "name": "html", "in": "query", "required": false, "description": "HTML content to process. Default:

Actoki Document

Generated by Actoki PDF API.

· Maximum 200000 characters", "schema": { "type": "string", "default": "

Actoki Document

Generated by Actoki PDF API.

", "example": "

Actoki Document

Generated by Actoki PDF API.

", "maxLength": 200000 }, "example": "

Actoki Document

Generated by Actoki PDF API.

" }, { "name": "invoice_number", "in": "query", "required": false, "description": "Request option: Invoice Number. Default: INV-TEST · Maximum 80 characters", "schema": { "type": "string", "default": "INV-TEST", "example": "INV-TEST", "maxLength": 80 }, "example": "INV-TEST" }, { "name": "amount", "in": "query", "required": false, "description": "Request option: Amount. Default: 0.00 · Maximum 40 characters", "schema": { "type": "string", "default": "0.00", "example": "0.00", "maxLength": 40 }, "example": "0.00" }, { "name": "engine", "in": "query", "required": true, "description": "Request option: Engine. Maximum 30 characters", "schema": { "type": "string", "example": "example", "maxLength": 30 }, "example": "example" }, { "name": "output", "in": "query", "required": false, "description": "Request option: Output. Default: base64 · Maximum 20 characters · Options: base64, download", "schema": { "type": "string", "enum": [ "base64", "download" ], "default": "base64", "example": "base64", "maxLength": 20 }, "example": "base64" }, { "name": "filename", "in": "query", "required": true, "description": "Request option: Filename. Maximum 120 characters", "schema": { "type": "string", "example": "example", "maxLength": 120 }, "example": "example" }, { "name": "paper", "in": "query", "required": false, "description": "Request option: Paper. Default: A4 · Maximum 20 characters · Options: A4, A3, Letter, Legal", "schema": { "type": "string", "enum": [ "A4", "A3", "Letter", "Legal" ], "default": "A4", "example": "A4", "maxLength": 20 }, "example": "A4" }, { "name": "orientation", "in": "query", "required": false, "description": "Request option: Orientation. Default: portrait · Maximum 20 characters · Options: portrait, landscape", "schema": { "type": "string", "enum": [ "portrait", "landscape" ], "default": "portrait", "example": "portrait", "maxLength": 20 }, "example": "portrait" } ], "x-actoki-response-fields": [ "operation", "engine", "output", "filename", "paper", "orientation", "remote", "provider_ready", "note", "html" ] }, "post": { "tags": [ "PDF / Document API" ], "summary": "Split PDFs.", "operationId": "pdf_documents_post_v1_pdf_split", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "pdf_documents", "x-actoki-units": 25, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "operation": [], "engine": [], "output": [], "filename": [], "paper": [], "orientation": [], "remote": [], "provider_ready": [], "note": [], "html": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/pdf/split.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "html": { "type": "string", "default": "

Actoki Document

Generated by Actoki PDF API.

", "example": "

Actoki Document

Generated by Actoki PDF API.

", "maxLength": 200000, "description": "HTML content to process. Default:

Actoki Document

Generated by Actoki PDF API.

· Maximum 200000 characters" }, "invoice_number": { "type": "string", "default": "INV-TEST", "example": "INV-TEST", "maxLength": 80, "description": "Request option: Invoice Number. Default: INV-TEST · Maximum 80 characters" }, "amount": { "type": "string", "default": "0.00", "example": "0.00", "maxLength": 40, "description": "Request option: Amount. Default: 0.00 · Maximum 40 characters" }, "engine": { "type": "string", "example": "example", "maxLength": 30, "description": "Request option: Engine. Maximum 30 characters" }, "output": { "type": "string", "enum": [ "base64", "download" ], "default": "base64", "example": "base64", "maxLength": 20, "description": "Request option: Output. Default: base64 · Maximum 20 characters · Options: base64, download" }, "filename": { "type": "string", "example": "example", "maxLength": 120, "description": "Request option: Filename. Maximum 120 characters" }, "paper": { "type": "string", "enum": [ "A4", "A3", "Letter", "Legal" ], "default": "A4", "example": "A4", "maxLength": 20, "description": "Request option: Paper. Default: A4 · Maximum 20 characters · Options: A4, A3, Letter, Legal" }, "orientation": { "type": "string", "enum": [ "portrait", "landscape" ], "default": "portrait", "example": "portrait", "maxLength": 20, "description": "Request option: Orientation. Default: portrait · Maximum 20 characters · Options: portrait, landscape" } }, "additionalProperties": false, "required": [ "engine", "filename" ] }, "example": { "html": "

Actoki Document

Generated by Actoki PDF API.

", "invoice_number": "INV-TEST", "amount": "0.00", "engine": "example", "filename": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "html": { "type": "string", "default": "

Actoki Document

Generated by Actoki PDF API.

", "example": "

Actoki Document

Generated by Actoki PDF API.

", "maxLength": 200000, "description": "HTML content to process. Default:

Actoki Document

Generated by Actoki PDF API.

· Maximum 200000 characters" }, "invoice_number": { "type": "string", "default": "INV-TEST", "example": "INV-TEST", "maxLength": 80, "description": "Request option: Invoice Number. Default: INV-TEST · Maximum 80 characters" }, "amount": { "type": "string", "default": "0.00", "example": "0.00", "maxLength": 40, "description": "Request option: Amount. Default: 0.00 · Maximum 40 characters" }, "engine": { "type": "string", "example": "example", "maxLength": 30, "description": "Request option: Engine. Maximum 30 characters" }, "output": { "type": "string", "enum": [ "base64", "download" ], "default": "base64", "example": "base64", "maxLength": 20, "description": "Request option: Output. Default: base64 · Maximum 20 characters · Options: base64, download" }, "filename": { "type": "string", "example": "example", "maxLength": 120, "description": "Request option: Filename. Maximum 120 characters" }, "paper": { "type": "string", "enum": [ "A4", "A3", "Letter", "Legal" ], "default": "A4", "example": "A4", "maxLength": 20, "description": "Request option: Paper. Default: A4 · Maximum 20 characters · Options: A4, A3, Letter, Legal" }, "orientation": { "type": "string", "enum": [ "portrait", "landscape" ], "default": "portrait", "example": "portrait", "maxLength": 20, "description": "Request option: Orientation. Default: portrait · Maximum 20 characters · Options: portrait, landscape" } }, "additionalProperties": false, "required": [ "engine", "filename" ] } } } }, "x-actoki-response-fields": [ "operation", "engine", "output", "filename", "paper", "orientation", "remote", "provider_ready", "note", "html" ] } }, "/v1/pdf/watermark": { "get": { "tags": [ "PDF / Document API" ], "summary": "Watermark PDF.", "operationId": "pdf_documents_get_v1_pdf_watermark", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "pdf_documents", "x-actoki-units": 25, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "operation": [], "engine": [], "output": [], "filename": [], "paper": [], "orientation": [], "remote": [], "provider_ready": [], "note": [], "html": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/pdf/watermark.php", "parameters": [ { "name": "html", "in": "query", "required": false, "description": "HTML content to process. Default:

Actoki Document

Generated by Actoki PDF API.

· Maximum 200000 characters", "schema": { "type": "string", "default": "

Actoki Document

Generated by Actoki PDF API.

", "example": "

Actoki Document

Generated by Actoki PDF API.

", "maxLength": 200000 }, "example": "

Actoki Document

Generated by Actoki PDF API.

" }, { "name": "invoice_number", "in": "query", "required": false, "description": "Request option: Invoice Number. Default: INV-TEST · Maximum 80 characters", "schema": { "type": "string", "default": "INV-TEST", "example": "INV-TEST", "maxLength": 80 }, "example": "INV-TEST" }, { "name": "amount", "in": "query", "required": false, "description": "Request option: Amount. Default: 0.00 · Maximum 40 characters", "schema": { "type": "string", "default": "0.00", "example": "0.00", "maxLength": 40 }, "example": "0.00" }, { "name": "engine", "in": "query", "required": true, "description": "Request option: Engine. Maximum 30 characters", "schema": { "type": "string", "example": "example", "maxLength": 30 }, "example": "example" }, { "name": "output", "in": "query", "required": false, "description": "Request option: Output. Default: base64 · Maximum 20 characters · Options: base64, download", "schema": { "type": "string", "enum": [ "base64", "download" ], "default": "base64", "example": "base64", "maxLength": 20 }, "example": "base64" }, { "name": "filename", "in": "query", "required": true, "description": "Request option: Filename. Maximum 120 characters", "schema": { "type": "string", "example": "example", "maxLength": 120 }, "example": "example" }, { "name": "paper", "in": "query", "required": false, "description": "Request option: Paper. Default: A4 · Maximum 20 characters · Options: A4, A3, Letter, Legal", "schema": { "type": "string", "enum": [ "A4", "A3", "Letter", "Legal" ], "default": "A4", "example": "A4", "maxLength": 20 }, "example": "A4" }, { "name": "orientation", "in": "query", "required": false, "description": "Request option: Orientation. Default: portrait · Maximum 20 characters · Options: portrait, landscape", "schema": { "type": "string", "enum": [ "portrait", "landscape" ], "default": "portrait", "example": "portrait", "maxLength": 20 }, "example": "portrait" } ], "x-actoki-response-fields": [ "operation", "engine", "output", "filename", "paper", "orientation", "remote", "provider_ready", "note", "html" ] }, "post": { "tags": [ "PDF / Document API" ], "summary": "Watermark PDF.", "operationId": "pdf_documents_post_v1_pdf_watermark", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "pdf_documents", "x-actoki-units": 25, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "operation": [], "engine": [], "output": [], "filename": [], "paper": [], "orientation": [], "remote": [], "provider_ready": [], "note": [], "html": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/pdf/watermark.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "html": { "type": "string", "default": "

Actoki Document

Generated by Actoki PDF API.

", "example": "

Actoki Document

Generated by Actoki PDF API.

", "maxLength": 200000, "description": "HTML content to process. Default:

Actoki Document

Generated by Actoki PDF API.

· Maximum 200000 characters" }, "invoice_number": { "type": "string", "default": "INV-TEST", "example": "INV-TEST", "maxLength": 80, "description": "Request option: Invoice Number. Default: INV-TEST · Maximum 80 characters" }, "amount": { "type": "string", "default": "0.00", "example": "0.00", "maxLength": 40, "description": "Request option: Amount. Default: 0.00 · Maximum 40 characters" }, "engine": { "type": "string", "example": "example", "maxLength": 30, "description": "Request option: Engine. Maximum 30 characters" }, "output": { "type": "string", "enum": [ "base64", "download" ], "default": "base64", "example": "base64", "maxLength": 20, "description": "Request option: Output. Default: base64 · Maximum 20 characters · Options: base64, download" }, "filename": { "type": "string", "example": "example", "maxLength": 120, "description": "Request option: Filename. Maximum 120 characters" }, "paper": { "type": "string", "enum": [ "A4", "A3", "Letter", "Legal" ], "default": "A4", "example": "A4", "maxLength": 20, "description": "Request option: Paper. Default: A4 · Maximum 20 characters · Options: A4, A3, Letter, Legal" }, "orientation": { "type": "string", "enum": [ "portrait", "landscape" ], "default": "portrait", "example": "portrait", "maxLength": 20, "description": "Request option: Orientation. Default: portrait · Maximum 20 characters · Options: portrait, landscape" } }, "additionalProperties": false, "required": [ "engine", "filename" ] }, "example": { "html": "

Actoki Document

Generated by Actoki PDF API.

", "invoice_number": "INV-TEST", "amount": "0.00", "engine": "example", "filename": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "html": { "type": "string", "default": "

Actoki Document

Generated by Actoki PDF API.

", "example": "

Actoki Document

Generated by Actoki PDF API.

", "maxLength": 200000, "description": "HTML content to process. Default:

Actoki Document

Generated by Actoki PDF API.

· Maximum 200000 characters" }, "invoice_number": { "type": "string", "default": "INV-TEST", "example": "INV-TEST", "maxLength": 80, "description": "Request option: Invoice Number. Default: INV-TEST · Maximum 80 characters" }, "amount": { "type": "string", "default": "0.00", "example": "0.00", "maxLength": 40, "description": "Request option: Amount. Default: 0.00 · Maximum 40 characters" }, "engine": { "type": "string", "example": "example", "maxLength": 30, "description": "Request option: Engine. Maximum 30 characters" }, "output": { "type": "string", "enum": [ "base64", "download" ], "default": "base64", "example": "base64", "maxLength": 20, "description": "Request option: Output. Default: base64 · Maximum 20 characters · Options: base64, download" }, "filename": { "type": "string", "example": "example", "maxLength": 120, "description": "Request option: Filename. Maximum 120 characters" }, "paper": { "type": "string", "enum": [ "A4", "A3", "Letter", "Legal" ], "default": "A4", "example": "A4", "maxLength": 20, "description": "Request option: Paper. Default: A4 · Maximum 20 characters · Options: A4, A3, Letter, Legal" }, "orientation": { "type": "string", "enum": [ "portrait", "landscape" ], "default": "portrait", "example": "portrait", "maxLength": 20, "description": "Request option: Orientation. Default: portrait · Maximum 20 characters · Options: portrait, landscape" } }, "additionalProperties": false, "required": [ "engine", "filename" ] } } } }, "x-actoki-response-fields": [ "operation", "engine", "output", "filename", "paper", "orientation", "remote", "provider_ready", "note", "html" ] } }, "/v1/pdf/metadata": { "get": { "tags": [ "PDF / Document API" ], "summary": "Read PDF metadata.", "operationId": "pdf_documents_get_v1_pdf_metadata", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "pdf_documents", "x-actoki-units": 25, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "operation": [], "engine": [], "output": [], "filename": [], "paper": [], "orientation": [], "remote": [], "provider_ready": [], "note": [], "html": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/pdf/metadata.php", "parameters": [ { "name": "html", "in": "query", "required": false, "description": "HTML content to process. Default:

Actoki Document

Generated by Actoki PDF API.

· Maximum 200000 characters", "schema": { "type": "string", "default": "

Actoki Document

Generated by Actoki PDF API.

", "example": "

Actoki Document

Generated by Actoki PDF API.

", "maxLength": 200000 }, "example": "

Actoki Document

Generated by Actoki PDF API.

" }, { "name": "invoice_number", "in": "query", "required": false, "description": "Request option: Invoice Number. Default: INV-TEST · Maximum 80 characters", "schema": { "type": "string", "default": "INV-TEST", "example": "INV-TEST", "maxLength": 80 }, "example": "INV-TEST" }, { "name": "amount", "in": "query", "required": false, "description": "Request option: Amount. Default: 0.00 · Maximum 40 characters", "schema": { "type": "string", "default": "0.00", "example": "0.00", "maxLength": 40 }, "example": "0.00" }, { "name": "engine", "in": "query", "required": true, "description": "Request option: Engine. Maximum 30 characters", "schema": { "type": "string", "example": "example", "maxLength": 30 }, "example": "example" }, { "name": "output", "in": "query", "required": false, "description": "Request option: Output. Default: base64 · Maximum 20 characters · Options: base64, download", "schema": { "type": "string", "enum": [ "base64", "download" ], "default": "base64", "example": "base64", "maxLength": 20 }, "example": "base64" }, { "name": "filename", "in": "query", "required": true, "description": "Request option: Filename. Maximum 120 characters", "schema": { "type": "string", "example": "example", "maxLength": 120 }, "example": "example" }, { "name": "paper", "in": "query", "required": false, "description": "Request option: Paper. Default: A4 · Maximum 20 characters · Options: A4, A3, Letter, Legal", "schema": { "type": "string", "enum": [ "A4", "A3", "Letter", "Legal" ], "default": "A4", "example": "A4", "maxLength": 20 }, "example": "A4" }, { "name": "orientation", "in": "query", "required": false, "description": "Request option: Orientation. Default: portrait · Maximum 20 characters · Options: portrait, landscape", "schema": { "type": "string", "enum": [ "portrait", "landscape" ], "default": "portrait", "example": "portrait", "maxLength": 20 }, "example": "portrait" } ], "x-actoki-response-fields": [ "operation", "engine", "output", "filename", "paper", "orientation", "remote", "provider_ready", "note", "html" ] }, "post": { "tags": [ "PDF / Document API" ], "summary": "Read PDF metadata.", "operationId": "pdf_documents_post_v1_pdf_metadata", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "pdf_documents", "x-actoki-units": 25, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "operation": [], "engine": [], "output": [], "filename": [], "paper": [], "orientation": [], "remote": [], "provider_ready": [], "note": [], "html": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/pdf/metadata.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "html": { "type": "string", "default": "

Actoki Document

Generated by Actoki PDF API.

", "example": "

Actoki Document

Generated by Actoki PDF API.

", "maxLength": 200000, "description": "HTML content to process. Default:

Actoki Document

Generated by Actoki PDF API.

· Maximum 200000 characters" }, "invoice_number": { "type": "string", "default": "INV-TEST", "example": "INV-TEST", "maxLength": 80, "description": "Request option: Invoice Number. Default: INV-TEST · Maximum 80 characters" }, "amount": { "type": "string", "default": "0.00", "example": "0.00", "maxLength": 40, "description": "Request option: Amount. Default: 0.00 · Maximum 40 characters" }, "engine": { "type": "string", "example": "example", "maxLength": 30, "description": "Request option: Engine. Maximum 30 characters" }, "output": { "type": "string", "enum": [ "base64", "download" ], "default": "base64", "example": "base64", "maxLength": 20, "description": "Request option: Output. Default: base64 · Maximum 20 characters · Options: base64, download" }, "filename": { "type": "string", "example": "example", "maxLength": 120, "description": "Request option: Filename. Maximum 120 characters" }, "paper": { "type": "string", "enum": [ "A4", "A3", "Letter", "Legal" ], "default": "A4", "example": "A4", "maxLength": 20, "description": "Request option: Paper. Default: A4 · Maximum 20 characters · Options: A4, A3, Letter, Legal" }, "orientation": { "type": "string", "enum": [ "portrait", "landscape" ], "default": "portrait", "example": "portrait", "maxLength": 20, "description": "Request option: Orientation. Default: portrait · Maximum 20 characters · Options: portrait, landscape" } }, "additionalProperties": false, "required": [ "engine", "filename" ] }, "example": { "html": "

Actoki Document

Generated by Actoki PDF API.

", "invoice_number": "INV-TEST", "amount": "0.00", "engine": "example", "filename": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "html": { "type": "string", "default": "

Actoki Document

Generated by Actoki PDF API.

", "example": "

Actoki Document

Generated by Actoki PDF API.

", "maxLength": 200000, "description": "HTML content to process. Default:

Actoki Document

Generated by Actoki PDF API.

· Maximum 200000 characters" }, "invoice_number": { "type": "string", "default": "INV-TEST", "example": "INV-TEST", "maxLength": 80, "description": "Request option: Invoice Number. Default: INV-TEST · Maximum 80 characters" }, "amount": { "type": "string", "default": "0.00", "example": "0.00", "maxLength": 40, "description": "Request option: Amount. Default: 0.00 · Maximum 40 characters" }, "engine": { "type": "string", "example": "example", "maxLength": 30, "description": "Request option: Engine. Maximum 30 characters" }, "output": { "type": "string", "enum": [ "base64", "download" ], "default": "base64", "example": "base64", "maxLength": 20, "description": "Request option: Output. Default: base64 · Maximum 20 characters · Options: base64, download" }, "filename": { "type": "string", "example": "example", "maxLength": 120, "description": "Request option: Filename. Maximum 120 characters" }, "paper": { "type": "string", "enum": [ "A4", "A3", "Letter", "Legal" ], "default": "A4", "example": "A4", "maxLength": 20, "description": "Request option: Paper. Default: A4 · Maximum 20 characters · Options: A4, A3, Letter, Legal" }, "orientation": { "type": "string", "enum": [ "portrait", "landscape" ], "default": "portrait", "example": "portrait", "maxLength": 20, "description": "Request option: Orientation. Default: portrait · Maximum 20 characters · Options: portrait, landscape" } }, "additionalProperties": false, "required": [ "engine", "filename" ] } } } }, "x-actoki-response-fields": [ "operation", "engine", "output", "filename", "paper", "orientation", "remote", "provider_ready", "note", "html" ] } }, "/v1/phone/validate": { "get": { "tags": [ "Phone Number API" ], "summary": "Validate phone number", "operationId": "phone_tools_get_v1_phone_validate", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "phone_tools", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "operation": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/phone/validate.php", "parameters": [ { "name": "phone", "in": "query", "required": true, "description": "Telephone number.", "schema": { "type": "string", "example": "+442079460000" }, "example": "+442079460000" }, { "name": "country", "in": "query", "required": false, "description": "ISO country code. Default: GB · Maximum 2 characters", "schema": { "type": "string", "default": "GB", "example": "GB", "maxLength": 2 }, "example": "GB" } ], "x-actoki-response-fields": [ "operation" ] }, "post": { "tags": [ "Phone Number API" ], "summary": "Validate phone number", "operationId": "phone_tools_post_v1_phone_validate", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "phone_tools", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "operation": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/phone/validate.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "phone": { "type": "string", "example": "+442079460000", "description": "Telephone number." }, "country": { "type": "string", "default": "GB", "example": "GB", "maxLength": 2, "description": "ISO country code. Default: GB · Maximum 2 characters" } }, "additionalProperties": false, "required": [ "phone" ] }, "example": { "phone": "+442079460000", "country": "GB" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "phone": { "type": "string", "example": "+442079460000", "description": "Telephone number." }, "country": { "type": "string", "default": "GB", "example": "GB", "maxLength": 2, "description": "ISO country code. Default: GB · Maximum 2 characters" } }, "additionalProperties": false, "required": [ "phone" ] } } } }, "x-actoki-response-fields": [ "operation" ] } }, "/v1/phone/format": { "get": { "tags": [ "Phone Number API" ], "summary": "Format phone number", "operationId": "phone_tools_get_v1_phone_format", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "phone_tools", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "operation": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/phone/format.php", "parameters": [ { "name": "phone", "in": "query", "required": true, "description": "Telephone number.", "schema": { "type": "string", "example": "+442079460000" }, "example": "+442079460000" }, { "name": "country", "in": "query", "required": false, "description": "ISO country code. Default: GB · Maximum 2 characters", "schema": { "type": "string", "default": "GB", "example": "GB", "maxLength": 2 }, "example": "GB" } ], "x-actoki-response-fields": [ "operation" ] }, "post": { "tags": [ "Phone Number API" ], "summary": "Format phone number", "operationId": "phone_tools_post_v1_phone_format", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "phone_tools", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "operation": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/phone/format.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "phone": { "type": "string", "example": "+442079460000", "description": "Telephone number." }, "country": { "type": "string", "default": "GB", "example": "GB", "maxLength": 2, "description": "ISO country code. Default: GB · Maximum 2 characters" } }, "additionalProperties": false, "required": [ "phone" ] }, "example": { "phone": "+442079460000", "country": "GB" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "phone": { "type": "string", "example": "+442079460000", "description": "Telephone number." }, "country": { "type": "string", "default": "GB", "example": "GB", "maxLength": 2, "description": "ISO country code. Default: GB · Maximum 2 characters" } }, "additionalProperties": false, "required": [ "phone" ] } } } }, "x-actoki-response-fields": [ "operation" ] } }, "/v1/phone/country": { "get": { "tags": [ "Phone Number API" ], "summary": "Detect phone country from prefix", "operationId": "phone_tools_get_v1_phone_country", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "phone_tools", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "operation": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/phone/country.php", "parameters": [ { "name": "phone", "in": "query", "required": true, "description": "Telephone number.", "schema": { "type": "string", "example": "+442079460000" }, "example": "+442079460000" }, { "name": "country", "in": "query", "required": false, "description": "ISO country code. Default: GB · Maximum 2 characters", "schema": { "type": "string", "default": "GB", "example": "GB", "maxLength": 2 }, "example": "GB" } ], "x-actoki-response-fields": [ "operation" ] }, "post": { "tags": [ "Phone Number API" ], "summary": "Detect phone country from prefix", "operationId": "phone_tools_post_v1_phone_country", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "phone_tools", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "operation": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/phone/country.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "phone": { "type": "string", "example": "+442079460000", "description": "Telephone number." }, "country": { "type": "string", "default": "GB", "example": "GB", "maxLength": 2, "description": "ISO country code. Default: GB · Maximum 2 characters" } }, "additionalProperties": false, "required": [ "phone" ] }, "example": { "phone": "+442079460000", "country": "GB" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "phone": { "type": "string", "example": "+442079460000", "description": "Telephone number." }, "country": { "type": "string", "default": "GB", "example": "GB", "maxLength": 2, "description": "ISO country code. Default: GB · Maximum 2 characters" } }, "additionalProperties": false, "required": [ "phone" ] } } } }, "x-actoki-response-fields": [ "operation" ] } }, "/v1/privacy/email-scan": { "get": { "tags": [ "Data Privacy Email Scanner API" ], "summary": "Email privacy scanner", "operationId": "privacy_scanner_get_v1_privacy_email_scan", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "privacy_scanner", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "pii": [], "secrets": [], "safe_to_store": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/privacy/email-scan.php", "parameters": [ { "name": "text", "in": "query", "required": true, "description": "Email text to scan for personal data and secrets. Maximum 200000 characters", "schema": { "type": "string", "example": "Please contact jane@example.com.", "maxLength": 200000 }, "example": "Please contact jane@example.com." } ], "x-actoki-response-fields": [ "pii", "secrets", "safe_to_store" ] }, "post": { "tags": [ "Data Privacy Email Scanner API" ], "summary": "Email privacy scanner", "operationId": "privacy_scanner_post_v1_privacy_email_scan", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "privacy_scanner", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "pii": [], "secrets": [], "safe_to_store": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/privacy/email-scan.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "Please contact jane@example.com.", "maxLength": 200000, "description": "Email text to scan for personal data and secrets. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "text" ] }, "example": { "text": "Please contact jane@example.com." } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "Please contact jane@example.com.", "maxLength": 200000, "description": "Email text to scan for personal data and secrets. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "text" ] } } } }, "x-actoki-response-fields": [ "pii", "secrets", "safe_to_store" ] } }, "/v1/privacy/support-message-scan": { "get": { "tags": [ "Data Privacy Email Scanner API" ], "summary": "Support message scanner", "operationId": "privacy_scanner_get_v1_privacy_support_message_scan", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "privacy_scanner", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "pii": [], "secrets": [], "safe_to_store": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/privacy/support-message-scan.php", "parameters": [ { "name": "text", "in": "query", "required": true, "description": "Support-message text to scan for personal data and secrets. Maximum 200000 characters", "schema": { "type": "string", "example": "My API key is hidden here.", "maxLength": 200000 }, "example": "My API key is hidden here." } ], "x-actoki-response-fields": [ "pii", "secrets", "safe_to_store" ] }, "post": { "tags": [ "Data Privacy Email Scanner API" ], "summary": "Support message scanner", "operationId": "privacy_scanner_post_v1_privacy_support_message_scan", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "privacy_scanner", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "pii": [], "secrets": [], "safe_to_store": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/privacy/support-message-scan.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "My API key is hidden here.", "maxLength": 200000, "description": "Support-message text to scan for personal data and secrets. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "text" ] }, "example": { "text": "My API key is hidden here." } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "My API key is hidden here.", "maxLength": 200000, "description": "Support-message text to scan for personal data and secrets. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "text" ] } } } }, "x-actoki-response-fields": [ "pii", "secrets", "safe_to_store" ] } }, "/v1/privacy/log-redact": { "get": { "tags": [ "Data Privacy Email Scanner API" ], "summary": "Log redaction", "operationId": "privacy_scanner_get_v1_privacy_log_redact", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "privacy_scanner", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "redacted": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/privacy/log-redact.php", "parameters": [ { "name": "text", "in": "query", "required": true, "description": "Text to process. Maximum 200000 characters", "schema": { "type": "string", "example": "example", "maxLength": 200000 }, "example": "example" } ], "x-actoki-response-fields": [ "redacted" ] }, "post": { "tags": [ "Data Privacy Email Scanner API" ], "summary": "Log redaction", "operationId": "privacy_scanner_post_v1_privacy_log_redact", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "privacy_scanner", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "redacted": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/privacy/log-redact.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "example", "maxLength": 200000, "description": "Text to process. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "text" ] }, "example": { "text": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "example", "maxLength": 200000, "description": "Text to process. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "text" ] } } } }, "x-actoki-response-fields": [ "redacted" ] } }, "/v1/qr/create": { "get": { "tags": [ "QR Code API" ], "summary": "Create generic QR SVG.", "operationId": "qr_code_get_v1_qr_create", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "qr_code", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": [], "data": [], "format": [], "svg": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/qr/create.php", "parameters": [ { "name": "data", "in": "query", "required": true, "description": "Request option: Data. Maximum 4000 characters", "schema": { "type": "string", "example": "example", "maxLength": 4000 }, "example": "example" }, { "name": "url", "in": "query", "required": false, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters", "schema": { "type": "string", "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000 }, "example": "https://actoki.com" }, { "name": "security", "in": "query", "required": false, "description": "Request option: Security. Default: WPA · Maximum 10 characters · Options: wifi, vcard, email, sms", "schema": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "WPA", "example": "WPA", "maxLength": 10 }, "example": "WPA" }, { "name": "ssid", "in": "query", "required": false, "description": "Request option: Ssid. Default: · Maximum 80 characters", "schema": { "type": "string", "default": "", "example": "example", "maxLength": 80 }, "example": "example" }, { "name": "password", "in": "query", "required": false, "description": "Request option: Password. Default: · Maximum 120 characters", "schema": { "type": "string", "default": "", "example": "example", "maxLength": 120 }, "example": "example" }, { "name": "name", "in": "query", "required": false, "description": "Human-readable name. Default: · Maximum 120 characters · Options: wifi, vcard, email, sms", "schema": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "example", "maxLength": 120 }, "example": "example" }, { "name": "phone", "in": "query", "required": false, "description": "Telephone number. Default: · Maximum 40 characters · Options: wifi, vcard, email, sms", "schema": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "+442079460000", "maxLength": 40 }, "example": "+442079460000" }, { "name": "email", "in": "query", "required": false, "description": "Email address. Default: · Maximum 120 characters · Options: wifi, vcard, email, sms", "schema": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "user@example.com", "maxLength": 120 }, "example": "user@example.com" }, { "name": "message", "in": "query", "required": false, "description": "Request option: Message. Default: · Maximum 200 characters · Options: wifi, vcard, email, sms", "schema": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "example", "maxLength": 200 }, "example": "example" }, { "name": "size", "in": "query", "required": false, "description": "Request option: Size. Default: 256 · Min: 128 · Max: 1024", "schema": { "type": "integer", "default": 256, "example": 256, "minimum": 128, "maximum": 1024 }, "example": 256 } ], "x-actoki-response-fields": [ "type", "data", "format", "svg" ] }, "post": { "tags": [ "QR Code API" ], "summary": "Create generic QR SVG.", "operationId": "qr_code_post_v1_qr_create", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "qr_code", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": [], "data": [], "format": [], "svg": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/qr/create.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "string", "example": "example", "maxLength": 4000, "description": "Request option: Data. Maximum 4000 characters" }, "url": { "type": "string", "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters" }, "security": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "WPA", "example": "WPA", "maxLength": 10, "description": "Request option: Security. Default: WPA · Maximum 10 characters · Options: wifi, vcard, email, sms" }, "ssid": { "type": "string", "default": "", "example": "example", "maxLength": 80, "description": "Request option: Ssid. Default: · Maximum 80 characters" }, "password": { "type": "string", "default": "", "example": "example", "maxLength": 120, "description": "Request option: Password. Default: · Maximum 120 characters" }, "name": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "example", "maxLength": 120, "description": "Human-readable name. Default: · Maximum 120 characters · Options: wifi, vcard, email, sms" }, "phone": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "+442079460000", "maxLength": 40, "description": "Telephone number. Default: · Maximum 40 characters · Options: wifi, vcard, email, sms" }, "email": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "user@example.com", "maxLength": 120, "description": "Email address. Default: · Maximum 120 characters · Options: wifi, vcard, email, sms" }, "message": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "example", "maxLength": 200, "description": "Request option: Message. Default: · Maximum 200 characters · Options: wifi, vcard, email, sms" }, "size": { "type": "integer", "default": 256, "example": 256, "minimum": 128, "maximum": 1024, "description": "Request option: Size. Default: 256 · Min: 128 · Max: 1024" } }, "additionalProperties": false, "required": [ "data" ] }, "example": { "data": "example", "url": "https://actoki.com", "security": "WPA" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "data": { "type": "string", "example": "example", "maxLength": 4000, "description": "Request option: Data. Maximum 4000 characters" }, "url": { "type": "string", "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters" }, "security": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "WPA", "example": "WPA", "maxLength": 10, "description": "Request option: Security. Default: WPA · Maximum 10 characters · Options: wifi, vcard, email, sms" }, "ssid": { "type": "string", "default": "", "example": "example", "maxLength": 80, "description": "Request option: Ssid. Default: · Maximum 80 characters" }, "password": { "type": "string", "default": "", "example": "example", "maxLength": 120, "description": "Request option: Password. Default: · Maximum 120 characters" }, "name": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "example", "maxLength": 120, "description": "Human-readable name. Default: · Maximum 120 characters · Options: wifi, vcard, email, sms" }, "phone": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "+442079460000", "maxLength": 40, "description": "Telephone number. Default: · Maximum 40 characters · Options: wifi, vcard, email, sms" }, "email": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "user@example.com", "maxLength": 120, "description": "Email address. Default: · Maximum 120 characters · Options: wifi, vcard, email, sms" }, "message": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "example", "maxLength": 200, "description": "Request option: Message. Default: · Maximum 200 characters · Options: wifi, vcard, email, sms" }, "size": { "type": "integer", "default": 256, "example": 256, "minimum": 128, "maximum": 1024, "description": "Request option: Size. Default: 256 · Min: 128 · Max: 1024" } }, "additionalProperties": false, "required": [ "data" ] } } } }, "x-actoki-response-fields": [ "type", "data", "format", "svg" ] } }, "/v1/qr/wifi": { "get": { "tags": [ "QR Code API" ], "summary": "Create WiFi QR.", "operationId": "qr_code_get_v1_qr_wifi", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "qr_code", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": [], "data": [], "format": [], "svg": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/qr/wifi.php", "parameters": [ { "name": "data", "in": "query", "required": true, "description": "Request option: Data. Maximum 4000 characters", "schema": { "type": "string", "example": "example", "maxLength": 4000 }, "example": "example" }, { "name": "url", "in": "query", "required": false, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters", "schema": { "type": "string", "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000 }, "example": "https://actoki.com" }, { "name": "security", "in": "query", "required": false, "description": "Request option: Security. Default: WPA · Maximum 10 characters · Options: wifi, vcard, email, sms", "schema": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "WPA", "example": "WPA", "maxLength": 10 }, "example": "WPA" }, { "name": "ssid", "in": "query", "required": false, "description": "Request option: Ssid. Default: · Maximum 80 characters", "schema": { "type": "string", "default": "", "example": "example", "maxLength": 80 }, "example": "example" }, { "name": "password", "in": "query", "required": false, "description": "Request option: Password. Default: · Maximum 120 characters", "schema": { "type": "string", "default": "", "example": "example", "maxLength": 120 }, "example": "example" }, { "name": "name", "in": "query", "required": false, "description": "Human-readable name. Default: · Maximum 120 characters · Options: wifi, vcard, email, sms", "schema": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "example", "maxLength": 120 }, "example": "example" }, { "name": "phone", "in": "query", "required": false, "description": "Telephone number. Default: · Maximum 40 characters · Options: wifi, vcard, email, sms", "schema": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "+442079460000", "maxLength": 40 }, "example": "+442079460000" }, { "name": "email", "in": "query", "required": false, "description": "Email address. Default: · Maximum 120 characters · Options: wifi, vcard, email, sms", "schema": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "user@example.com", "maxLength": 120 }, "example": "user@example.com" }, { "name": "message", "in": "query", "required": false, "description": "Request option: Message. Default: · Maximum 200 characters · Options: wifi, vcard, email, sms", "schema": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "example", "maxLength": 200 }, "example": "example" }, { "name": "size", "in": "query", "required": false, "description": "Request option: Size. Default: 256 · Min: 128 · Max: 1024", "schema": { "type": "integer", "default": 256, "example": 256, "minimum": 128, "maximum": 1024 }, "example": 256 } ], "x-actoki-response-fields": [ "type", "data", "format", "svg" ] }, "post": { "tags": [ "QR Code API" ], "summary": "Create WiFi QR.", "operationId": "qr_code_post_v1_qr_wifi", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "qr_code", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": [], "data": [], "format": [], "svg": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/qr/wifi.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "string", "example": "example", "maxLength": 4000, "description": "Request option: Data. Maximum 4000 characters" }, "url": { "type": "string", "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters" }, "security": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "WPA", "example": "WPA", "maxLength": 10, "description": "Request option: Security. Default: WPA · Maximum 10 characters · Options: wifi, vcard, email, sms" }, "ssid": { "type": "string", "default": "", "example": "example", "maxLength": 80, "description": "Request option: Ssid. Default: · Maximum 80 characters" }, "password": { "type": "string", "default": "", "example": "example", "maxLength": 120, "description": "Request option: Password. Default: · Maximum 120 characters" }, "name": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "example", "maxLength": 120, "description": "Human-readable name. Default: · Maximum 120 characters · Options: wifi, vcard, email, sms" }, "phone": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "+442079460000", "maxLength": 40, "description": "Telephone number. Default: · Maximum 40 characters · Options: wifi, vcard, email, sms" }, "email": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "user@example.com", "maxLength": 120, "description": "Email address. Default: · Maximum 120 characters · Options: wifi, vcard, email, sms" }, "message": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "example", "maxLength": 200, "description": "Request option: Message. Default: · Maximum 200 characters · Options: wifi, vcard, email, sms" }, "size": { "type": "integer", "default": 256, "example": 256, "minimum": 128, "maximum": 1024, "description": "Request option: Size. Default: 256 · Min: 128 · Max: 1024" } }, "additionalProperties": false, "required": [ "data" ] }, "example": { "data": "example", "url": "https://actoki.com", "security": "WPA" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "data": { "type": "string", "example": "example", "maxLength": 4000, "description": "Request option: Data. Maximum 4000 characters" }, "url": { "type": "string", "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters" }, "security": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "WPA", "example": "WPA", "maxLength": 10, "description": "Request option: Security. Default: WPA · Maximum 10 characters · Options: wifi, vcard, email, sms" }, "ssid": { "type": "string", "default": "", "example": "example", "maxLength": 80, "description": "Request option: Ssid. Default: · Maximum 80 characters" }, "password": { "type": "string", "default": "", "example": "example", "maxLength": 120, "description": "Request option: Password. Default: · Maximum 120 characters" }, "name": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "example", "maxLength": 120, "description": "Human-readable name. Default: · Maximum 120 characters · Options: wifi, vcard, email, sms" }, "phone": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "+442079460000", "maxLength": 40, "description": "Telephone number. Default: · Maximum 40 characters · Options: wifi, vcard, email, sms" }, "email": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "user@example.com", "maxLength": 120, "description": "Email address. Default: · Maximum 120 characters · Options: wifi, vcard, email, sms" }, "message": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "example", "maxLength": 200, "description": "Request option: Message. Default: · Maximum 200 characters · Options: wifi, vcard, email, sms" }, "size": { "type": "integer", "default": 256, "example": 256, "minimum": 128, "maximum": 1024, "description": "Request option: Size. Default: 256 · Min: 128 · Max: 1024" } }, "additionalProperties": false, "required": [ "data" ] } } } }, "x-actoki-response-fields": [ "type", "data", "format", "svg" ] } }, "/v1/qr/vcard": { "get": { "tags": [ "QR Code API" ], "summary": "Create vCard QR.", "operationId": "qr_code_get_v1_qr_vcard", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "qr_code", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": [], "data": [], "format": [], "svg": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/qr/vcard.php", "parameters": [ { "name": "data", "in": "query", "required": true, "description": "Request option: Data. Maximum 4000 characters", "schema": { "type": "string", "example": "example", "maxLength": 4000 }, "example": "example" }, { "name": "url", "in": "query", "required": false, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters", "schema": { "type": "string", "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000 }, "example": "https://actoki.com" }, { "name": "security", "in": "query", "required": false, "description": "Request option: Security. Default: WPA · Maximum 10 characters · Options: wifi, vcard, email, sms", "schema": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "WPA", "example": "WPA", "maxLength": 10 }, "example": "WPA" }, { "name": "ssid", "in": "query", "required": false, "description": "Request option: Ssid. Default: · Maximum 80 characters", "schema": { "type": "string", "default": "", "example": "example", "maxLength": 80 }, "example": "example" }, { "name": "password", "in": "query", "required": false, "description": "Request option: Password. Default: · Maximum 120 characters", "schema": { "type": "string", "default": "", "example": "example", "maxLength": 120 }, "example": "example" }, { "name": "name", "in": "query", "required": false, "description": "Human-readable name. Default: · Maximum 120 characters · Options: wifi, vcard, email, sms", "schema": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "example", "maxLength": 120 }, "example": "example" }, { "name": "phone", "in": "query", "required": false, "description": "Telephone number. Default: · Maximum 40 characters · Options: wifi, vcard, email, sms", "schema": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "+442079460000", "maxLength": 40 }, "example": "+442079460000" }, { "name": "email", "in": "query", "required": false, "description": "Email address. Default: · Maximum 120 characters · Options: wifi, vcard, email, sms", "schema": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "user@example.com", "maxLength": 120 }, "example": "user@example.com" }, { "name": "message", "in": "query", "required": false, "description": "Request option: Message. Default: · Maximum 200 characters · Options: wifi, vcard, email, sms", "schema": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "example", "maxLength": 200 }, "example": "example" }, { "name": "size", "in": "query", "required": false, "description": "Request option: Size. Default: 256 · Min: 128 · Max: 1024", "schema": { "type": "integer", "default": 256, "example": 256, "minimum": 128, "maximum": 1024 }, "example": 256 } ], "x-actoki-response-fields": [ "type", "data", "format", "svg" ] }, "post": { "tags": [ "QR Code API" ], "summary": "Create vCard QR.", "operationId": "qr_code_post_v1_qr_vcard", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "qr_code", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": [], "data": [], "format": [], "svg": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/qr/vcard.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "string", "example": "example", "maxLength": 4000, "description": "Request option: Data. Maximum 4000 characters" }, "url": { "type": "string", "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters" }, "security": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "WPA", "example": "WPA", "maxLength": 10, "description": "Request option: Security. Default: WPA · Maximum 10 characters · Options: wifi, vcard, email, sms" }, "ssid": { "type": "string", "default": "", "example": "example", "maxLength": 80, "description": "Request option: Ssid. Default: · Maximum 80 characters" }, "password": { "type": "string", "default": "", "example": "example", "maxLength": 120, "description": "Request option: Password. Default: · Maximum 120 characters" }, "name": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "example", "maxLength": 120, "description": "Human-readable name. Default: · Maximum 120 characters · Options: wifi, vcard, email, sms" }, "phone": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "+442079460000", "maxLength": 40, "description": "Telephone number. Default: · Maximum 40 characters · Options: wifi, vcard, email, sms" }, "email": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "user@example.com", "maxLength": 120, "description": "Email address. Default: · Maximum 120 characters · Options: wifi, vcard, email, sms" }, "message": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "example", "maxLength": 200, "description": "Request option: Message. Default: · Maximum 200 characters · Options: wifi, vcard, email, sms" }, "size": { "type": "integer", "default": 256, "example": 256, "minimum": 128, "maximum": 1024, "description": "Request option: Size. Default: 256 · Min: 128 · Max: 1024" } }, "additionalProperties": false, "required": [ "data" ] }, "example": { "data": "example", "url": "https://actoki.com", "security": "WPA" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "data": { "type": "string", "example": "example", "maxLength": 4000, "description": "Request option: Data. Maximum 4000 characters" }, "url": { "type": "string", "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters" }, "security": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "WPA", "example": "WPA", "maxLength": 10, "description": "Request option: Security. Default: WPA · Maximum 10 characters · Options: wifi, vcard, email, sms" }, "ssid": { "type": "string", "default": "", "example": "example", "maxLength": 80, "description": "Request option: Ssid. Default: · Maximum 80 characters" }, "password": { "type": "string", "default": "", "example": "example", "maxLength": 120, "description": "Request option: Password. Default: · Maximum 120 characters" }, "name": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "example", "maxLength": 120, "description": "Human-readable name. Default: · Maximum 120 characters · Options: wifi, vcard, email, sms" }, "phone": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "+442079460000", "maxLength": 40, "description": "Telephone number. Default: · Maximum 40 characters · Options: wifi, vcard, email, sms" }, "email": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "user@example.com", "maxLength": 120, "description": "Email address. Default: · Maximum 120 characters · Options: wifi, vcard, email, sms" }, "message": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "example", "maxLength": 200, "description": "Request option: Message. Default: · Maximum 200 characters · Options: wifi, vcard, email, sms" }, "size": { "type": "integer", "default": 256, "example": 256, "minimum": 128, "maximum": 1024, "description": "Request option: Size. Default: 256 · Min: 128 · Max: 1024" } }, "additionalProperties": false, "required": [ "data" ] } } } }, "x-actoki-response-fields": [ "type", "data", "format", "svg" ] } }, "/v1/qr/email": { "get": { "tags": [ "QR Code API" ], "summary": "Create email QR.", "operationId": "qr_code_get_v1_qr_email", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "qr_code", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": [], "data": [], "format": [], "svg": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/qr/email.php", "parameters": [ { "name": "data", "in": "query", "required": true, "description": "Request option: Data. Maximum 4000 characters", "schema": { "type": "string", "example": "example", "maxLength": 4000 }, "example": "example" }, { "name": "url", "in": "query", "required": false, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters", "schema": { "type": "string", "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000 }, "example": "https://actoki.com" }, { "name": "security", "in": "query", "required": false, "description": "Request option: Security. Default: WPA · Maximum 10 characters · Options: wifi, vcard, email, sms", "schema": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "WPA", "example": "WPA", "maxLength": 10 }, "example": "WPA" }, { "name": "ssid", "in": "query", "required": false, "description": "Request option: Ssid. Default: · Maximum 80 characters", "schema": { "type": "string", "default": "", "example": "example", "maxLength": 80 }, "example": "example" }, { "name": "password", "in": "query", "required": false, "description": "Request option: Password. Default: · Maximum 120 characters", "schema": { "type": "string", "default": "", "example": "example", "maxLength": 120 }, "example": "example" }, { "name": "name", "in": "query", "required": false, "description": "Human-readable name. Default: · Maximum 120 characters · Options: wifi, vcard, email, sms", "schema": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "example", "maxLength": 120 }, "example": "example" }, { "name": "phone", "in": "query", "required": false, "description": "Telephone number. Default: · Maximum 40 characters · Options: wifi, vcard, email, sms", "schema": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "+442079460000", "maxLength": 40 }, "example": "+442079460000" }, { "name": "email", "in": "query", "required": false, "description": "Email address. Default: · Maximum 120 characters · Options: wifi, vcard, email, sms", "schema": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "user@example.com", "maxLength": 120 }, "example": "user@example.com" }, { "name": "message", "in": "query", "required": false, "description": "Request option: Message. Default: · Maximum 200 characters · Options: wifi, vcard, email, sms", "schema": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "example", "maxLength": 200 }, "example": "example" }, { "name": "size", "in": "query", "required": false, "description": "Request option: Size. Default: 256 · Min: 128 · Max: 1024", "schema": { "type": "integer", "default": 256, "example": 256, "minimum": 128, "maximum": 1024 }, "example": 256 } ], "x-actoki-response-fields": [ "type", "data", "format", "svg" ] }, "post": { "tags": [ "QR Code API" ], "summary": "Create email QR.", "operationId": "qr_code_post_v1_qr_email", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "qr_code", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": [], "data": [], "format": [], "svg": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/qr/email.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "string", "example": "example", "maxLength": 4000, "description": "Request option: Data. Maximum 4000 characters" }, "url": { "type": "string", "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters" }, "security": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "WPA", "example": "WPA", "maxLength": 10, "description": "Request option: Security. Default: WPA · Maximum 10 characters · Options: wifi, vcard, email, sms" }, "ssid": { "type": "string", "default": "", "example": "example", "maxLength": 80, "description": "Request option: Ssid. Default: · Maximum 80 characters" }, "password": { "type": "string", "default": "", "example": "example", "maxLength": 120, "description": "Request option: Password. Default: · Maximum 120 characters" }, "name": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "example", "maxLength": 120, "description": "Human-readable name. Default: · Maximum 120 characters · Options: wifi, vcard, email, sms" }, "phone": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "+442079460000", "maxLength": 40, "description": "Telephone number. Default: · Maximum 40 characters · Options: wifi, vcard, email, sms" }, "email": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "user@example.com", "maxLength": 120, "description": "Email address. Default: · Maximum 120 characters · Options: wifi, vcard, email, sms" }, "message": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "example", "maxLength": 200, "description": "Request option: Message. Default: · Maximum 200 characters · Options: wifi, vcard, email, sms" }, "size": { "type": "integer", "default": 256, "example": 256, "minimum": 128, "maximum": 1024, "description": "Request option: Size. Default: 256 · Min: 128 · Max: 1024" } }, "additionalProperties": false, "required": [ "data" ] }, "example": { "data": "example", "url": "https://actoki.com", "security": "WPA" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "data": { "type": "string", "example": "example", "maxLength": 4000, "description": "Request option: Data. Maximum 4000 characters" }, "url": { "type": "string", "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters" }, "security": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "WPA", "example": "WPA", "maxLength": 10, "description": "Request option: Security. Default: WPA · Maximum 10 characters · Options: wifi, vcard, email, sms" }, "ssid": { "type": "string", "default": "", "example": "example", "maxLength": 80, "description": "Request option: Ssid. Default: · Maximum 80 characters" }, "password": { "type": "string", "default": "", "example": "example", "maxLength": 120, "description": "Request option: Password. Default: · Maximum 120 characters" }, "name": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "example", "maxLength": 120, "description": "Human-readable name. Default: · Maximum 120 characters · Options: wifi, vcard, email, sms" }, "phone": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "+442079460000", "maxLength": 40, "description": "Telephone number. Default: · Maximum 40 characters · Options: wifi, vcard, email, sms" }, "email": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "user@example.com", "maxLength": 120, "description": "Email address. Default: · Maximum 120 characters · Options: wifi, vcard, email, sms" }, "message": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "example", "maxLength": 200, "description": "Request option: Message. Default: · Maximum 200 characters · Options: wifi, vcard, email, sms" }, "size": { "type": "integer", "default": 256, "example": 256, "minimum": 128, "maximum": 1024, "description": "Request option: Size. Default: 256 · Min: 128 · Max: 1024" } }, "additionalProperties": false, "required": [ "data" ] } } } }, "x-actoki-response-fields": [ "type", "data", "format", "svg" ] } }, "/v1/qr/sms": { "get": { "tags": [ "QR Code API" ], "summary": "Create SMS QR.", "operationId": "qr_code_get_v1_qr_sms", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "qr_code", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": [], "data": [], "format": [], "svg": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/qr/sms.php", "parameters": [ { "name": "data", "in": "query", "required": true, "description": "Request option: Data. Maximum 4000 characters", "schema": { "type": "string", "example": "example", "maxLength": 4000 }, "example": "example" }, { "name": "url", "in": "query", "required": false, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters", "schema": { "type": "string", "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000 }, "example": "https://actoki.com" }, { "name": "security", "in": "query", "required": false, "description": "Request option: Security. Default: WPA · Maximum 10 characters · Options: wifi, vcard, email, sms", "schema": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "WPA", "example": "WPA", "maxLength": 10 }, "example": "WPA" }, { "name": "ssid", "in": "query", "required": false, "description": "Request option: Ssid. Default: · Maximum 80 characters", "schema": { "type": "string", "default": "", "example": "example", "maxLength": 80 }, "example": "example" }, { "name": "password", "in": "query", "required": false, "description": "Request option: Password. Default: · Maximum 120 characters", "schema": { "type": "string", "default": "", "example": "example", "maxLength": 120 }, "example": "example" }, { "name": "name", "in": "query", "required": false, "description": "Human-readable name. Default: · Maximum 120 characters · Options: wifi, vcard, email, sms", "schema": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "example", "maxLength": 120 }, "example": "example" }, { "name": "phone", "in": "query", "required": false, "description": "Telephone number. Default: · Maximum 40 characters · Options: wifi, vcard, email, sms", "schema": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "+442079460000", "maxLength": 40 }, "example": "+442079460000" }, { "name": "email", "in": "query", "required": false, "description": "Email address. Default: · Maximum 120 characters · Options: wifi, vcard, email, sms", "schema": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "user@example.com", "maxLength": 120 }, "example": "user@example.com" }, { "name": "message", "in": "query", "required": false, "description": "Request option: Message. Default: · Maximum 200 characters · Options: wifi, vcard, email, sms", "schema": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "example", "maxLength": 200 }, "example": "example" }, { "name": "size", "in": "query", "required": false, "description": "Request option: Size. Default: 256 · Min: 128 · Max: 1024", "schema": { "type": "integer", "default": 256, "example": 256, "minimum": 128, "maximum": 1024 }, "example": 256 } ], "x-actoki-response-fields": [ "type", "data", "format", "svg" ] }, "post": { "tags": [ "QR Code API" ], "summary": "Create SMS QR.", "operationId": "qr_code_post_v1_qr_sms", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "qr_code", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": [], "data": [], "format": [], "svg": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/qr/sms.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "string", "example": "example", "maxLength": 4000, "description": "Request option: Data. Maximum 4000 characters" }, "url": { "type": "string", "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters" }, "security": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "WPA", "example": "WPA", "maxLength": 10, "description": "Request option: Security. Default: WPA · Maximum 10 characters · Options: wifi, vcard, email, sms" }, "ssid": { "type": "string", "default": "", "example": "example", "maxLength": 80, "description": "Request option: Ssid. Default: · Maximum 80 characters" }, "password": { "type": "string", "default": "", "example": "example", "maxLength": 120, "description": "Request option: Password. Default: · Maximum 120 characters" }, "name": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "example", "maxLength": 120, "description": "Human-readable name. Default: · Maximum 120 characters · Options: wifi, vcard, email, sms" }, "phone": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "+442079460000", "maxLength": 40, "description": "Telephone number. Default: · Maximum 40 characters · Options: wifi, vcard, email, sms" }, "email": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "user@example.com", "maxLength": 120, "description": "Email address. Default: · Maximum 120 characters · Options: wifi, vcard, email, sms" }, "message": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "example", "maxLength": 200, "description": "Request option: Message. Default: · Maximum 200 characters · Options: wifi, vcard, email, sms" }, "size": { "type": "integer", "default": 256, "example": 256, "minimum": 128, "maximum": 1024, "description": "Request option: Size. Default: 256 · Min: 128 · Max: 1024" } }, "additionalProperties": false, "required": [ "data" ] }, "example": { "data": "example", "url": "https://actoki.com", "security": "WPA" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "data": { "type": "string", "example": "example", "maxLength": 4000, "description": "Request option: Data. Maximum 4000 characters" }, "url": { "type": "string", "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters" }, "security": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "WPA", "example": "WPA", "maxLength": 10, "description": "Request option: Security. Default: WPA · Maximum 10 characters · Options: wifi, vcard, email, sms" }, "ssid": { "type": "string", "default": "", "example": "example", "maxLength": 80, "description": "Request option: Ssid. Default: · Maximum 80 characters" }, "password": { "type": "string", "default": "", "example": "example", "maxLength": 120, "description": "Request option: Password. Default: · Maximum 120 characters" }, "name": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "example", "maxLength": 120, "description": "Human-readable name. Default: · Maximum 120 characters · Options: wifi, vcard, email, sms" }, "phone": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "+442079460000", "maxLength": 40, "description": "Telephone number. Default: · Maximum 40 characters · Options: wifi, vcard, email, sms" }, "email": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "user@example.com", "maxLength": 120, "description": "Email address. Default: · Maximum 120 characters · Options: wifi, vcard, email, sms" }, "message": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "example", "maxLength": 200, "description": "Request option: Message. Default: · Maximum 200 characters · Options: wifi, vcard, email, sms" }, "size": { "type": "integer", "default": 256, "example": 256, "minimum": 128, "maximum": 1024, "description": "Request option: Size. Default: 256 · Min: 128 · Max: 1024" } }, "additionalProperties": false, "required": [ "data" ] } } } }, "x-actoki-response-fields": [ "type", "data", "format", "svg" ] } }, "/v1/qr/url": { "get": { "tags": [ "QR Code API" ], "summary": "Create URL QR.", "operationId": "qr_code_get_v1_qr_url", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "qr_code", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": [], "data": [], "format": [], "svg": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/qr/url.php", "parameters": [ { "name": "data", "in": "query", "required": true, "description": "Request option: Data. Maximum 4000 characters", "schema": { "type": "string", "example": "example", "maxLength": 4000 }, "example": "example" }, { "name": "url", "in": "query", "required": false, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters", "schema": { "type": "string", "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000 }, "example": "https://actoki.com" }, { "name": "security", "in": "query", "required": false, "description": "Request option: Security. Default: WPA · Maximum 10 characters · Options: wifi, vcard, email, sms", "schema": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "WPA", "example": "WPA", "maxLength": 10 }, "example": "WPA" }, { "name": "ssid", "in": "query", "required": false, "description": "Request option: Ssid. Default: · Maximum 80 characters", "schema": { "type": "string", "default": "", "example": "example", "maxLength": 80 }, "example": "example" }, { "name": "password", "in": "query", "required": false, "description": "Request option: Password. Default: · Maximum 120 characters", "schema": { "type": "string", "default": "", "example": "example", "maxLength": 120 }, "example": "example" }, { "name": "name", "in": "query", "required": false, "description": "Human-readable name. Default: · Maximum 120 characters · Options: wifi, vcard, email, sms", "schema": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "example", "maxLength": 120 }, "example": "example" }, { "name": "phone", "in": "query", "required": false, "description": "Telephone number. Default: · Maximum 40 characters · Options: wifi, vcard, email, sms", "schema": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "+442079460000", "maxLength": 40 }, "example": "+442079460000" }, { "name": "email", "in": "query", "required": false, "description": "Email address. Default: · Maximum 120 characters · Options: wifi, vcard, email, sms", "schema": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "user@example.com", "maxLength": 120 }, "example": "user@example.com" }, { "name": "message", "in": "query", "required": false, "description": "Request option: Message. Default: · Maximum 200 characters · Options: wifi, vcard, email, sms", "schema": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "example", "maxLength": 200 }, "example": "example" }, { "name": "size", "in": "query", "required": false, "description": "Request option: Size. Default: 256 · Min: 128 · Max: 1024", "schema": { "type": "integer", "default": 256, "example": 256, "minimum": 128, "maximum": 1024 }, "example": 256 } ], "x-actoki-response-fields": [ "type", "data", "format", "svg" ] }, "post": { "tags": [ "QR Code API" ], "summary": "Create URL QR.", "operationId": "qr_code_post_v1_qr_url", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "qr_code", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "type": [], "data": [], "format": [], "svg": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/qr/url.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "string", "example": "example", "maxLength": 4000, "description": "Request option: Data. Maximum 4000 characters" }, "url": { "type": "string", "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters" }, "security": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "WPA", "example": "WPA", "maxLength": 10, "description": "Request option: Security. Default: WPA · Maximum 10 characters · Options: wifi, vcard, email, sms" }, "ssid": { "type": "string", "default": "", "example": "example", "maxLength": 80, "description": "Request option: Ssid. Default: · Maximum 80 characters" }, "password": { "type": "string", "default": "", "example": "example", "maxLength": 120, "description": "Request option: Password. Default: · Maximum 120 characters" }, "name": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "example", "maxLength": 120, "description": "Human-readable name. Default: · Maximum 120 characters · Options: wifi, vcard, email, sms" }, "phone": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "+442079460000", "maxLength": 40, "description": "Telephone number. Default: · Maximum 40 characters · Options: wifi, vcard, email, sms" }, "email": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "user@example.com", "maxLength": 120, "description": "Email address. Default: · Maximum 120 characters · Options: wifi, vcard, email, sms" }, "message": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "example", "maxLength": 200, "description": "Request option: Message. Default: · Maximum 200 characters · Options: wifi, vcard, email, sms" }, "size": { "type": "integer", "default": 256, "example": 256, "minimum": 128, "maximum": 1024, "description": "Request option: Size. Default: 256 · Min: 128 · Max: 1024" } }, "additionalProperties": false, "required": [ "data" ] }, "example": { "data": "example", "url": "https://actoki.com", "security": "WPA" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "data": { "type": "string", "example": "example", "maxLength": 4000, "description": "Request option: Data. Maximum 4000 characters" }, "url": { "type": "string", "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters" }, "security": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "WPA", "example": "WPA", "maxLength": 10, "description": "Request option: Security. Default: WPA · Maximum 10 characters · Options: wifi, vcard, email, sms" }, "ssid": { "type": "string", "default": "", "example": "example", "maxLength": 80, "description": "Request option: Ssid. Default: · Maximum 80 characters" }, "password": { "type": "string", "default": "", "example": "example", "maxLength": 120, "description": "Request option: Password. Default: · Maximum 120 characters" }, "name": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "example", "maxLength": 120, "description": "Human-readable name. Default: · Maximum 120 characters · Options: wifi, vcard, email, sms" }, "phone": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "+442079460000", "maxLength": 40, "description": "Telephone number. Default: · Maximum 40 characters · Options: wifi, vcard, email, sms" }, "email": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "user@example.com", "maxLength": 120, "description": "Email address. Default: · Maximum 120 characters · Options: wifi, vcard, email, sms" }, "message": { "type": "string", "enum": [ "wifi", "vcard", "email", "sms" ], "default": "", "example": "example", "maxLength": 200, "description": "Request option: Message. Default: · Maximum 200 characters · Options: wifi, vcard, email, sms" }, "size": { "type": "integer", "default": 256, "example": 256, "minimum": 128, "maximum": 1024, "description": "Request option: Size. Default: 256 · Min: 128 · Max: 1024" } }, "additionalProperties": false, "required": [ "data" ] } } } }, "x-actoki-response-fields": [ "type", "data", "format", "svg" ] } }, "/v1/risk/email": { "get": { "tags": [ "Fraud & Risk Scoring API" ], "summary": "Email risk score", "operationId": "risk_scoring_get_v1_risk_email", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "risk_scoring", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "risk_score": [], "risk_level": [], "signals": [], "domain": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/risk/email.php", "parameters": [ { "name": "email", "in": "query", "required": true, "description": "Email address. Maximum 255 characters", "schema": { "type": "string", "example": "user@example.com", "maxLength": 255 }, "example": "user@example.com" }, { "name": "domain", "in": "query", "required": true, "description": "Domain name without a path.", "schema": { "type": "string", "example": "example.com" }, "example": "example.com" }, { "name": "ip", "in": "query", "required": false, "description": "Request option: Ip. Default:", "schema": { "type": "string", "default": "", "example": "example" }, "example": "example" } ], "x-actoki-response-fields": [ "risk_score", "risk_level", "signals", "domain" ] }, "post": { "tags": [ "Fraud & Risk Scoring API" ], "summary": "Email risk score", "operationId": "risk_scoring_post_v1_risk_email", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "risk_scoring", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "risk_score": [], "risk_level": [], "signals": [], "domain": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/risk/email.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "example": "user@example.com", "maxLength": 255, "description": "Email address. Maximum 255 characters" }, "domain": { "type": "string", "example": "example.com", "description": "Domain name without a path." }, "ip": { "type": "string", "default": "", "example": "example", "description": "Request option: Ip. Default:" } }, "additionalProperties": false, "required": [ "email", "domain" ] }, "example": { "email": "user@example.com", "domain": "example.com", "ip": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "email": { "type": "string", "example": "user@example.com", "maxLength": 255, "description": "Email address. Maximum 255 characters" }, "domain": { "type": "string", "example": "example.com", "description": "Domain name without a path." }, "ip": { "type": "string", "default": "", "example": "example", "description": "Request option: Ip. Default:" } }, "additionalProperties": false, "required": [ "email", "domain" ] } } } }, "x-actoki-response-fields": [ "risk_score", "risk_level", "signals", "domain" ] } }, "/v1/risk/ip": { "get": { "tags": [ "Fraud & Risk Scoring API" ], "summary": "IP risk score", "operationId": "risk_scoring_get_v1_risk_ip", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "risk_scoring", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "risk_score": [], "risk_level": [], "signals": [], "domain": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/risk/ip.php", "parameters": [ { "name": "email", "in": "query", "required": true, "description": "Email address. Maximum 255 characters", "schema": { "type": "string", "example": "user@example.com", "maxLength": 255 }, "example": "user@example.com" }, { "name": "domain", "in": "query", "required": true, "description": "Domain name without a path.", "schema": { "type": "string", "example": "example.com" }, "example": "example.com" }, { "name": "ip", "in": "query", "required": false, "description": "Request option: Ip. Default:", "schema": { "type": "string", "default": "", "example": "example" }, "example": "example" } ], "x-actoki-response-fields": [ "risk_score", "risk_level", "signals", "domain" ] }, "post": { "tags": [ "Fraud & Risk Scoring API" ], "summary": "IP risk score", "operationId": "risk_scoring_post_v1_risk_ip", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "risk_scoring", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "risk_score": [], "risk_level": [], "signals": [], "domain": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/risk/ip.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "example": "user@example.com", "maxLength": 255, "description": "Email address. Maximum 255 characters" }, "domain": { "type": "string", "example": "example.com", "description": "Domain name without a path." }, "ip": { "type": "string", "default": "", "example": "example", "description": "Request option: Ip. Default:" } }, "additionalProperties": false, "required": [ "email", "domain" ] }, "example": { "email": "user@example.com", "domain": "example.com", "ip": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "email": { "type": "string", "example": "user@example.com", "maxLength": 255, "description": "Email address. Maximum 255 characters" }, "domain": { "type": "string", "example": "example.com", "description": "Domain name without a path." }, "ip": { "type": "string", "default": "", "example": "example", "description": "Request option: Ip. Default:" } }, "additionalProperties": false, "required": [ "email", "domain" ] } } } }, "x-actoki-response-fields": [ "risk_score", "risk_level", "signals", "domain" ] } }, "/v1/risk/signup": { "get": { "tags": [ "Fraud & Risk Scoring API" ], "summary": "Signup risk score", "operationId": "risk_scoring_get_v1_risk_signup", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "risk_scoring", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "risk_score": [], "risk_level": [], "signals": [], "domain": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/risk/signup.php", "parameters": [ { "name": "email", "in": "query", "required": true, "description": "Email address. Maximum 255 characters", "schema": { "type": "string", "example": "user@example.com", "maxLength": 255 }, "example": "user@example.com" }, { "name": "domain", "in": "query", "required": true, "description": "Domain name without a path.", "schema": { "type": "string", "example": "example.com" }, "example": "example.com" }, { "name": "ip", "in": "query", "required": false, "description": "Request option: Ip. Default:", "schema": { "type": "string", "default": "", "example": "example" }, "example": "example" } ], "x-actoki-response-fields": [ "risk_score", "risk_level", "signals", "domain" ] }, "post": { "tags": [ "Fraud & Risk Scoring API" ], "summary": "Signup risk score", "operationId": "risk_scoring_post_v1_risk_signup", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "risk_scoring", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "risk_score": [], "risk_level": [], "signals": [], "domain": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/risk/signup.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "example": "user@example.com", "maxLength": 255, "description": "Email address. Maximum 255 characters" }, "domain": { "type": "string", "example": "example.com", "description": "Domain name without a path." }, "ip": { "type": "string", "default": "", "example": "example", "description": "Request option: Ip. Default:" } }, "additionalProperties": false, "required": [ "email", "domain" ] }, "example": { "email": "user@example.com", "domain": "example.com", "ip": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "email": { "type": "string", "example": "user@example.com", "maxLength": 255, "description": "Email address. Maximum 255 characters" }, "domain": { "type": "string", "example": "example.com", "description": "Domain name without a path." }, "ip": { "type": "string", "default": "", "example": "example", "description": "Request option: Ip. Default:" } }, "additionalProperties": false, "required": [ "email", "domain" ] } } } }, "x-actoki-response-fields": [ "risk_score", "risk_level", "signals", "domain" ] } }, "/v1/risk/order": { "get": { "tags": [ "Fraud & Risk Scoring API" ], "summary": "Order risk score", "operationId": "risk_scoring_get_v1_risk_order", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "risk_scoring", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "risk_score": [], "risk_level": [], "signals": [], "domain": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/risk/order.php", "parameters": [ { "name": "email", "in": "query", "required": true, "description": "Email address. Maximum 255 characters", "schema": { "type": "string", "example": "user@example.com", "maxLength": 255 }, "example": "user@example.com" }, { "name": "domain", "in": "query", "required": true, "description": "Domain name without a path.", "schema": { "type": "string", "example": "example.com" }, "example": "example.com" }, { "name": "ip", "in": "query", "required": false, "description": "Request option: Ip. Default:", "schema": { "type": "string", "default": "", "example": "example" }, "example": "example" } ], "x-actoki-response-fields": [ "risk_score", "risk_level", "signals", "domain" ] }, "post": { "tags": [ "Fraud & Risk Scoring API" ], "summary": "Order risk score", "operationId": "risk_scoring_post_v1_risk_order", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "risk_scoring", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "risk_score": [], "risk_level": [], "signals": [], "domain": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/risk/order.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "example": "user@example.com", "maxLength": 255, "description": "Email address. Maximum 255 characters" }, "domain": { "type": "string", "example": "example.com", "description": "Domain name without a path." }, "ip": { "type": "string", "default": "", "example": "example", "description": "Request option: Ip. Default:" } }, "additionalProperties": false, "required": [ "email", "domain" ] }, "example": { "email": "user@example.com", "domain": "example.com", "ip": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "email": { "type": "string", "example": "user@example.com", "maxLength": 255, "description": "Email address. Maximum 255 characters" }, "domain": { "type": "string", "example": "example.com", "description": "Domain name without a path." }, "ip": { "type": "string", "default": "", "example": "example", "description": "Request option: Ip. Default:" } }, "additionalProperties": false, "required": [ "email", "domain" ] } } } }, "x-actoki-response-fields": [ "risk_score", "risk_level", "signals", "domain" ] } }, "/v1/rules/evaluate": { "get": { "tags": [ "Business Rules / Decision API" ], "summary": "Evaluate a JSON ruleset against input data", "operationId": "rules_engine_get_v1_rules_evaluate", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "rules_engine", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/rules/evaluate.php", "parameters": [ { "name": "rules", "in": "query", "required": false, "description": "Request option: Rules. Default:", "schema": { "type": "string", "default": null, "example": "example" }, "example": "example" }, { "name": "input", "in": "query", "required": false, "description": "Request option: Input. Default:", "schema": { "type": "string", "default": null, "example": "example" }, "example": "example" } ] }, "post": { "tags": [ "Business Rules / Decision API" ], "summary": "Evaluate a JSON ruleset against input data", "operationId": "rules_engine_post_v1_rules_evaluate", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "rules_engine", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/rules/evaluate.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "rules": { "type": "string", "default": null, "example": "example", "description": "Request option: Rules. Default:" }, "input": { "type": "string", "default": null, "example": "example", "description": "Request option: Input. Default:" } }, "additionalProperties": false }, "example": { "rules": "example", "input": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "rules": { "type": "string", "default": null, "example": "example", "description": "Request option: Rules. Default:" }, "input": { "type": "string", "default": null, "example": "example", "description": "Request option: Input. Default:" } }, "additionalProperties": false } } } } } }, "/v1/security/secrets-scan": { "get": { "tags": [ "Security Headers & Secret Scanner API" ], "summary": "Secret scanner", "operationId": "security_headers_get_v1_security_secrets_scan", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "security_headers", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "api_key": [], "private_key": [], "jwt": [], "has_secrets": [], "matches": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/security/secrets-scan.php", "parameters": [ { "name": "text", "in": "query", "required": true, "description": "Text to process. Maximum 200000 characters", "schema": { "type": "string", "example": "example", "maxLength": 200000 }, "example": "example" } ], "x-actoki-response-fields": [ "api_key", "private_key", "jwt", "has_secrets", "matches" ] }, "post": { "tags": [ "Security Headers & Secret Scanner API" ], "summary": "Secret scanner", "operationId": "security_headers_post_v1_security_secrets_scan", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "security_headers", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "api_key": [], "private_key": [], "jwt": [], "has_secrets": [], "matches": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/security/secrets-scan.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "example", "maxLength": 200000, "description": "Text to process. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "text" ] }, "example": { "text": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "example", "maxLength": 200000, "description": "Text to process. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "text" ] } } } }, "x-actoki-response-fields": [ "api_key", "private_key", "jwt", "has_secrets", "matches" ] } }, "/v1/security/api-key-detect": { "get": { "tags": [ "Security Headers & Secret Scanner API" ], "summary": "API key detector", "operationId": "security_headers_get_v1_security_api_key_detect", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "security_headers", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "api_key": [], "private_key": [], "jwt": [], "has_secrets": [], "matches": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/security/api-key-detect.php", "parameters": [ { "name": "text", "in": "query", "required": true, "description": "Text to process. Maximum 200000 characters", "schema": { "type": "string", "example": "example", "maxLength": 200000 }, "example": "example" } ], "x-actoki-response-fields": [ "api_key", "private_key", "jwt", "has_secrets", "matches" ] }, "post": { "tags": [ "Security Headers & Secret Scanner API" ], "summary": "API key detector", "operationId": "security_headers_post_v1_security_api_key_detect", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "security_headers", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "api_key": [], "private_key": [], "jwt": [], "has_secrets": [], "matches": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/security/api-key-detect.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "example", "maxLength": 200000, "description": "Text to process. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "text" ] }, "example": { "text": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "example", "maxLength": 200000, "description": "Text to process. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "text" ] } } } }, "x-actoki-response-fields": [ "api_key", "private_key", "jwt", "has_secrets", "matches" ] } }, "/v1/security/env-check": { "get": { "tags": [ "Security Headers & Secret Scanner API" ], "summary": "ENV file safety check", "operationId": "security_headers_get_v1_security_env_check", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "security_headers", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "api_key": [], "private_key": [], "jwt": [], "has_secrets": [], "matches": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/security/env-check.php", "parameters": [ { "name": "text", "in": "query", "required": true, "description": "Text to process. Maximum 200000 characters", "schema": { "type": "string", "example": "example", "maxLength": 200000 }, "example": "example" } ], "x-actoki-response-fields": [ "api_key", "private_key", "jwt", "has_secrets", "matches" ] }, "post": { "tags": [ "Security Headers & Secret Scanner API" ], "summary": "ENV file safety check", "operationId": "security_headers_post_v1_security_env_check", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "security_headers", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "api_key": [], "private_key": [], "jwt": [], "has_secrets": [], "matches": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/security/env-check.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "example", "maxLength": 200000, "description": "Text to process. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "text" ] }, "example": { "text": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "text": { "type": "string", "example": "example", "maxLength": 200000, "description": "Text to process. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "text" ] } } } }, "x-actoki-response-fields": [ "api_key", "private_key", "jwt", "has_secrets", "matches" ] } }, "/v1/seo/page": { "get": { "tags": [ "SEO Audit API" ], "summary": "Basic page SEO audit.", "operationId": "seo_audit_get_v1_seo_page", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "seo_audit", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/seo/page.php", "parameters": [ { "name": "url", "in": "query", "required": false, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters", "schema": { "type": "string", "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000 }, "example": "https://actoki.com" } ] }, "post": { "tags": [ "SEO Audit API" ], "summary": "Basic page SEO audit.", "operationId": "seo_audit_post_v1_seo_page", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "seo_audit", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/seo/page.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters" } }, "additionalProperties": false }, "example": { "url": "https://actoki.com" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "url": { "type": "string", "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters" } }, "additionalProperties": false } } } } } }, "/v1/seo/meta": { "get": { "tags": [ "SEO Audit API" ], "summary": "Check meta tags.", "operationId": "seo_audit_get_v1_seo_meta", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "seo_audit", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/seo/meta.php", "parameters": [ { "name": "url", "in": "query", "required": false, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters", "schema": { "type": "string", "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000 }, "example": "https://actoki.com" } ] }, "post": { "tags": [ "SEO Audit API" ], "summary": "Check meta tags.", "operationId": "seo_audit_post_v1_seo_meta", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "seo_audit", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/seo/meta.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters" } }, "additionalProperties": false }, "example": { "url": "https://actoki.com" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "url": { "type": "string", "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters" } }, "additionalProperties": false } } } } } }, "/v1/seo/headings": { "get": { "tags": [ "SEO Audit API" ], "summary": "Check headings.", "operationId": "seo_audit_get_v1_seo_headings", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "seo_audit", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/seo/headings.php", "parameters": [ { "name": "url", "in": "query", "required": false, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters", "schema": { "type": "string", "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000 }, "example": "https://actoki.com" } ] }, "post": { "tags": [ "SEO Audit API" ], "summary": "Check headings.", "operationId": "seo_audit_post_v1_seo_headings", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "seo_audit", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/seo/headings.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters" } }, "additionalProperties": false }, "example": { "url": "https://actoki.com" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "url": { "type": "string", "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters" } }, "additionalProperties": false } } } } } }, "/v1/seo/links": { "get": { "tags": [ "SEO Audit API" ], "summary": "Extract links.", "operationId": "seo_audit_get_v1_seo_links", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "seo_audit", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/seo/links.php", "parameters": [ { "name": "url", "in": "query", "required": false, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters", "schema": { "type": "string", "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000 }, "example": "https://actoki.com" } ] }, "post": { "tags": [ "SEO Audit API" ], "summary": "Extract links.", "operationId": "seo_audit_post_v1_seo_links", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "seo_audit", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/seo/links.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters" } }, "additionalProperties": false }, "example": { "url": "https://actoki.com" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "url": { "type": "string", "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters" } }, "additionalProperties": false } } } } } }, "/v1/seo/schema": { "get": { "tags": [ "SEO Audit API" ], "summary": "Check schema.", "operationId": "seo_audit_get_v1_seo_schema", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "seo_audit", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/seo/schema.php", "parameters": [ { "name": "url", "in": "query", "required": false, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters", "schema": { "type": "string", "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000 }, "example": "https://actoki.com" } ] }, "post": { "tags": [ "SEO Audit API" ], "summary": "Check schema.", "operationId": "seo_audit_post_v1_seo_schema", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "seo_audit", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/seo/schema.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters" } }, "additionalProperties": false }, "example": { "url": "https://actoki.com" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "url": { "type": "string", "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters" } }, "additionalProperties": false } } } } } }, "/v1/seo/sitemap": { "get": { "tags": [ "SEO Audit API" ], "summary": "Check sitemap.", "operationId": "seo_audit_get_v1_seo_sitemap", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "seo_audit", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/seo/sitemap.php", "parameters": [ { "name": "url", "in": "query", "required": false, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters", "schema": { "type": "string", "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000 }, "example": "https://actoki.com" } ] }, "post": { "tags": [ "SEO Audit API" ], "summary": "Check sitemap.", "operationId": "seo_audit_post_v1_seo_sitemap", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "seo_audit", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/seo/sitemap.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters" } }, "additionalProperties": false }, "example": { "url": "https://actoki.com" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "url": { "type": "string", "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters" } }, "additionalProperties": false } } } } } }, "/v1/seo/robots": { "get": { "tags": [ "SEO Audit API" ], "summary": "Check robots.txt.", "operationId": "seo_audit_get_v1_seo_robots", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "seo_audit", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/seo/robots.php", "parameters": [ { "name": "url", "in": "query", "required": false, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters", "schema": { "type": "string", "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000 }, "example": "https://actoki.com" } ] }, "post": { "tags": [ "SEO Audit API" ], "summary": "Check robots.txt.", "operationId": "seo_audit_post_v1_seo_robots", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "seo_audit", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/seo/robots.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters" } }, "additionalProperties": false }, "example": { "url": "https://actoki.com" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "url": { "type": "string", "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters" } }, "additionalProperties": false } } } } } }, "/v1/spam-test/tests": { "get": { "tags": [ "Spam Test" ], "summary": "Create a one-off spam-test address or list previous tests.", "operationId": "spam_test_get_v1_spam_test_tests", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "spam_test", "x-actoki-units": 40, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "test": [], "tests": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/spam-test/tests.php", "parameters": [ { "name": "label", "in": "query", "required": false, "description": "Request option: Label. Default:", "schema": { "type": "string", "default": "", "example": "example" }, "example": "example" } ], "x-actoki-response-fields": [ "test", "tests" ] }, "post": { "tags": [ "Spam Test" ], "summary": "Create a one-off spam-test address or list previous tests.", "operationId": "spam_test_post_v1_spam_test_tests", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "spam_test", "x-actoki-units": 40, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "test": [], "tests": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/spam-test/tests.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string", "default": "", "example": "example", "description": "Request option: Label. Default:" } }, "additionalProperties": false }, "example": { "label": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "label": { "type": "string", "default": "", "example": "example", "description": "Request option: Label. Default:" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "test", "tests" ] } }, "/v1/spam-test/status": { "get": { "tags": [ "Spam Test" ], "summary": "Read the score and itemised report for a spam test.", "operationId": "spam_test_get_v1_spam_test_status", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "spam_test", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": [], "test": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "query string" ], "x-actoki-source": "httpdocs/v1/spam-test/status.php", "parameters": [ { "name": "id", "in": "query", "required": false, "description": "Request option: Id.", "schema": { "type": "string", "example": "example" }, "example": "example" } ], "x-actoki-response-fields": [ "error", "test" ] } }, "/v1/spreadsheet/profile": { "get": { "tags": [ "CSV & Spreadsheet Quality API" ], "summary": "Spreadsheet profile", "operationId": "spreadsheet_quality_get_v1_spreadsheet_profile", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "spreadsheet_quality", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": [], "columns": [], "headers": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/spreadsheet/profile.php", "parameters": [ { "name": "csv", "in": "query", "required": true, "description": "CSV text including a header row. Maximum 200000 characters", "schema": { "type": "string", "example": "example", "maxLength": 200000 }, "example": "example" } ], "x-actoki-response-fields": [ "rows", "columns", "headers" ] }, "post": { "tags": [ "CSV & Spreadsheet Quality API" ], "summary": "Spreadsheet profile", "operationId": "spreadsheet_quality_post_v1_spreadsheet_profile", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "spreadsheet_quality", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": [], "columns": [], "headers": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/spreadsheet/profile.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "csv": { "type": "string", "example": "example", "maxLength": 200000, "description": "CSV text including a header row. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "csv" ] }, "example": { "csv": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "csv": { "type": "string", "example": "example", "maxLength": 200000, "description": "CSV text including a header row. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "csv" ] } } } }, "x-actoki-response-fields": [ "rows", "columns", "headers" ] } }, "/v1/spreadsheet/clean": { "get": { "tags": [ "CSV & Spreadsheet Quality API" ], "summary": "Spreadsheet cleaner", "operationId": "spreadsheet_quality_get_v1_spreadsheet_clean", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "spreadsheet_quality", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "cleaned": [], "note": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/spreadsheet/clean.php", "parameters": [ { "name": "csv", "in": "query", "required": true, "description": "CSV text including a header row. Maximum 200000 characters", "schema": { "type": "string", "example": "example", "maxLength": 200000 }, "example": "example" } ], "x-actoki-response-fields": [ "cleaned", "note" ] }, "post": { "tags": [ "CSV & Spreadsheet Quality API" ], "summary": "Spreadsheet cleaner", "operationId": "spreadsheet_quality_post_v1_spreadsheet_clean", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "spreadsheet_quality", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "cleaned": [], "note": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/spreadsheet/clean.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "csv": { "type": "string", "example": "example", "maxLength": 200000, "description": "CSV text including a header row. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "csv" ] }, "example": { "csv": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "csv": { "type": "string", "example": "example", "maxLength": 200000, "description": "CSV text including a header row. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "csv" ] } } } }, "x-actoki-response-fields": [ "cleaned", "note" ] } }, "/v1/spreadsheet/detect-columns": { "get": { "tags": [ "CSV & Spreadsheet Quality API" ], "summary": "Detect columns", "operationId": "spreadsheet_quality_get_v1_spreadsheet_detect_columns", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "spreadsheet_quality", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "headers": [], "guesses": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/spreadsheet/detect-columns.php", "parameters": [ { "name": "csv", "in": "query", "required": true, "description": "CSV text including a header row. Maximum 200000 characters", "schema": { "type": "string", "example": "example", "maxLength": 200000 }, "example": "example" } ], "x-actoki-response-fields": [ "headers", "guesses" ] }, "post": { "tags": [ "CSV & Spreadsheet Quality API" ], "summary": "Detect columns", "operationId": "spreadsheet_quality_post_v1_spreadsheet_detect_columns", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "spreadsheet_quality", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "headers": [], "guesses": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/spreadsheet/detect-columns.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "csv": { "type": "string", "example": "example", "maxLength": 200000, "description": "CSV text including a header row. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "csv" ] }, "example": { "csv": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "csv": { "type": "string", "example": "example", "maxLength": 200000, "description": "CSV text including a header row. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "csv" ] } } } }, "x-actoki-response-fields": [ "headers", "guesses" ] } }, "/v1/spreadsheet/validate-emails": { "get": { "tags": [ "CSV & Spreadsheet Quality API" ], "summary": "Validate emails in table", "operationId": "spreadsheet_quality_get_v1_spreadsheet_validate_emails", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "spreadsheet_quality", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "email_count": [], "emails": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/spreadsheet/validate-emails.php", "parameters": [ { "name": "csv", "in": "query", "required": true, "description": "CSV text including a header row. Maximum 200000 characters", "schema": { "type": "string", "example": "example", "maxLength": 200000 }, "example": "example" } ], "x-actoki-response-fields": [ "email_count", "emails" ] }, "post": { "tags": [ "CSV & Spreadsheet Quality API" ], "summary": "Validate emails in table", "operationId": "spreadsheet_quality_post_v1_spreadsheet_validate_emails", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "spreadsheet_quality", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "email_count": [], "emails": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/spreadsheet/validate-emails.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "csv": { "type": "string", "example": "example", "maxLength": 200000, "description": "CSV text including a header row. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "csv" ] }, "example": { "csv": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "csv": { "type": "string", "example": "example", "maxLength": 200000, "description": "CSV text including a header row. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "csv" ] } } } }, "x-actoki-response-fields": [ "email_count", "emails" ] } }, "/v1/spreadsheet/dedupe-rows": { "get": { "tags": [ "CSV & Spreadsheet Quality API" ], "summary": "Dedupe rows", "operationId": "spreadsheet_quality_get_v1_spreadsheet_dedupe_rows", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "spreadsheet_quality", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/spreadsheet/dedupe-rows.php", "parameters": [ { "name": "csv", "in": "query", "required": true, "description": "CSV text including a header row. Maximum 200000 characters", "schema": { "type": "string", "example": "example", "maxLength": 200000 }, "example": "example" } ], "x-actoki-response-fields": [ "rows" ] }, "post": { "tags": [ "CSV & Spreadsheet Quality API" ], "summary": "Dedupe rows", "operationId": "spreadsheet_quality_post_v1_spreadsheet_dedupe_rows", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "spreadsheet_quality", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/spreadsheet/dedupe-rows.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "csv": { "type": "string", "example": "example", "maxLength": 200000, "description": "CSV text including a header row. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "csv" ] }, "example": { "csv": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "csv": { "type": "string", "example": "example", "maxLength": 200000, "description": "CSV text including a header row. Maximum 200000 characters" } }, "additionalProperties": false, "required": [ "csv" ] } } } }, "x-actoki-response-fields": [ "rows" ] } }, "/v1/text/slugify": { "get": { "tags": [ "Text Tools API" ], "summary": "Create slug.", "operationId": "text_tools_get_v1_text_slugify", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "text_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/text/slugify.php", "parameters": [ { "name": "text", "in": "query", "required": false, "description": "Text to process. Default: · Maximum 1000 characters", "schema": { "type": "string", "default": "", "example": "example", "maxLength": 1000 }, "example": "example" } ], "x-actoki-response-fields": [ "slug" ] }, "post": { "tags": [ "Text Tools API" ], "summary": "Create slug.", "operationId": "text_tools_post_v1_text_slugify", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "text_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/text/slugify.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "default": "", "example": "example", "maxLength": 1000, "description": "Text to process. Default: · Maximum 1000 characters" } }, "additionalProperties": false }, "example": { "text": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "text": { "type": "string", "default": "", "example": "example", "maxLength": 1000, "description": "Text to process. Default: · Maximum 1000 characters" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "slug" ] } }, "/v1/text/case": { "get": { "tags": [ "Text Tools API" ], "summary": "Convert case.", "operationId": "text_tools_get_v1_text_case", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "text_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/text/case.php", "parameters": [ { "name": "text", "in": "query", "required": false, "description": "Text to process. Default: · Maximum 100000 characters", "schema": { "type": "string", "default": "", "example": "example", "maxLength": 100000 }, "example": "example" }, { "name": "case", "in": "query", "required": false, "description": "Request option: Case. Default: title · Maximum 20 characters · Options: upper, lower", "schema": { "type": "string", "enum": [ "upper", "lower" ], "default": "title", "example": "title", "maxLength": 20 }, "example": "title" } ], "x-actoki-response-fields": [ "text" ] }, "post": { "tags": [ "Text Tools API" ], "summary": "Convert case.", "operationId": "text_tools_post_v1_text_case", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "text_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/text/case.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "default": "", "example": "example", "maxLength": 100000, "description": "Text to process. Default: · Maximum 100000 characters" }, "case": { "type": "string", "enum": [ "upper", "lower" ], "default": "title", "example": "title", "maxLength": 20, "description": "Request option: Case. Default: title · Maximum 20 characters · Options: upper, lower" } }, "additionalProperties": false }, "example": { "text": "example", "case": "title" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "text": { "type": "string", "default": "", "example": "example", "maxLength": 100000, "description": "Text to process. Default: · Maximum 100000 characters" }, "case": { "type": "string", "enum": [ "upper", "lower" ], "default": "title", "example": "title", "maxLength": 20, "description": "Request option: Case. Default: title · Maximum 20 characters · Options: upper, lower" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "text" ] } }, "/v1/text/count": { "get": { "tags": [ "Text Tools API" ], "summary": "Count text.", "operationId": "text_tools_get_v1_text_count", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "text_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "characters": [], "words": [], "lines": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/text/count.php", "parameters": [ { "name": "text", "in": "query", "required": false, "description": "Text to process. Default: · Maximum 100000 characters", "schema": { "type": "string", "default": "", "example": "example", "maxLength": 100000 }, "example": "example" } ], "x-actoki-response-fields": [ "characters", "words", "lines" ] }, "post": { "tags": [ "Text Tools API" ], "summary": "Count text.", "operationId": "text_tools_post_v1_text_count", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "text_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "characters": [], "words": [], "lines": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/text/count.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "default": "", "example": "example", "maxLength": 100000, "description": "Text to process. Default: · Maximum 100000 characters" } }, "additionalProperties": false }, "example": { "text": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "text": { "type": "string", "default": "", "example": "example", "maxLength": 100000, "description": "Text to process. Default: · Maximum 100000 characters" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "characters", "words", "lines" ] } }, "/v1/text/extract-emails": { "get": { "tags": [ "Text Tools API" ], "summary": "Extract emails.", "operationId": "text_tools_get_v1_text_extract_emails", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "text_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/text/extract-emails.php", "parameters": [ { "name": "text", "in": "query", "required": false, "description": "Text to process. Default: · Maximum 100000 characters · Options: /v1/text/extract-emails, /v1/text/extract-phones", "schema": { "type": "string", "enum": [ "/v1/text/extract-emails", "/v1/text/extract-phones" ], "default": "", "example": "example", "maxLength": 100000 }, "example": "example" } ], "x-actoki-response-fields": [ "items" ] }, "post": { "tags": [ "Text Tools API" ], "summary": "Extract emails.", "operationId": "text_tools_post_v1_text_extract_emails", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "text_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/text/extract-emails.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "enum": [ "/v1/text/extract-emails", "/v1/text/extract-phones" ], "default": "", "example": "example", "maxLength": 100000, "description": "Text to process. Default: · Maximum 100000 characters · Options: /v1/text/extract-emails, /v1/text/extract-phones" } }, "additionalProperties": false }, "example": { "text": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "text": { "type": "string", "enum": [ "/v1/text/extract-emails", "/v1/text/extract-phones" ], "default": "", "example": "example", "maxLength": 100000, "description": "Text to process. Default: · Maximum 100000 characters · Options: /v1/text/extract-emails, /v1/text/extract-phones" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "items" ] } }, "/v1/text/extract-phones": { "get": { "tags": [ "Text Tools API" ], "summary": "Extract phones.", "operationId": "text_tools_get_v1_text_extract_phones", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "text_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/text/extract-phones.php", "parameters": [ { "name": "text", "in": "query", "required": false, "description": "Text to process. Default: · Maximum 100000 characters · Options: /v1/text/extract-emails, /v1/text/extract-phones", "schema": { "type": "string", "enum": [ "/v1/text/extract-emails", "/v1/text/extract-phones" ], "default": "", "example": "example", "maxLength": 100000 }, "example": "example" } ], "x-actoki-response-fields": [ "items" ] }, "post": { "tags": [ "Text Tools API" ], "summary": "Extract phones.", "operationId": "text_tools_post_v1_text_extract_phones", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "text_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/text/extract-phones.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "enum": [ "/v1/text/extract-emails", "/v1/text/extract-phones" ], "default": "", "example": "example", "maxLength": 100000, "description": "Text to process. Default: · Maximum 100000 characters · Options: /v1/text/extract-emails, /v1/text/extract-phones" } }, "additionalProperties": false }, "example": { "text": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "text": { "type": "string", "enum": [ "/v1/text/extract-emails", "/v1/text/extract-phones" ], "default": "", "example": "example", "maxLength": 100000, "description": "Text to process. Default: · Maximum 100000 characters · Options: /v1/text/extract-emails, /v1/text/extract-phones" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "items" ] } }, "/v1/text/remove-duplicates": { "get": { "tags": [ "Text Tools API" ], "summary": "Remove duplicates.", "operationId": "text_tools_get_v1_text_remove_duplicates", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "text_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/text/remove-duplicates.php", "parameters": [ { "name": "text", "in": "query", "required": false, "description": "Text to process. Default: · Maximum 100000 characters", "schema": { "type": "string", "default": "", "example": "example", "maxLength": 100000 }, "example": "example" } ], "x-actoki-response-fields": [ "text" ] }, "post": { "tags": [ "Text Tools API" ], "summary": "Remove duplicates.", "operationId": "text_tools_post_v1_text_remove_duplicates", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "text_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/text/remove-duplicates.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "default": "", "example": "example", "maxLength": 100000, "description": "Text to process. Default: · Maximum 100000 characters" } }, "additionalProperties": false }, "example": { "text": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "text": { "type": "string", "default": "", "example": "example", "maxLength": 100000, "description": "Text to process. Default: · Maximum 100000 characters" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "text" ] } }, "/v1/text/diff": { "get": { "tags": [ "Text Tools API" ], "summary": "Simple diff summary.", "operationId": "text_tools_get_v1_text_diff", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "text_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "changed": [], "old_length": [], "new_length": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/text/diff.php", "parameters": [ { "name": "old", "in": "query", "required": false, "description": "Request option: Old. Default: · Maximum 100000 characters", "schema": { "type": "string", "default": "", "example": "example", "maxLength": 100000 }, "example": "example" }, { "name": "new", "in": "query", "required": false, "description": "Request option: New. Default: · Maximum 100000 characters", "schema": { "type": "string", "default": "", "example": "example", "maxLength": 100000 }, "example": "example" } ], "x-actoki-response-fields": [ "changed", "old_length", "new_length" ] }, "post": { "tags": [ "Text Tools API" ], "summary": "Simple diff summary.", "operationId": "text_tools_post_v1_text_diff", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "text_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "changed": [], "old_length": [], "new_length": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/text/diff.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "old": { "type": "string", "default": "", "example": "example", "maxLength": 100000, "description": "Request option: Old. Default: · Maximum 100000 characters" }, "new": { "type": "string", "default": "", "example": "example", "maxLength": 100000, "description": "Request option: New. Default: · Maximum 100000 characters" } }, "additionalProperties": false }, "example": { "old": "example", "new": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "old": { "type": "string", "default": "", "example": "example", "maxLength": 100000, "description": "Request option: Old. Default: · Maximum 100000 characters" }, "new": { "type": "string", "default": "", "example": "example", "maxLength": 100000, "description": "Request option: New. Default: · Maximum 100000 characters" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "changed", "old_length", "new_length" ] } }, "/v1/text/lorem": { "get": { "tags": [ "Text Tools API" ], "summary": "Generate lorem ipsum.", "operationId": "text_tools_get_v1_text_lorem", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "text_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/text/lorem.php", "parameters": [ { "name": "words", "in": "query", "required": false, "description": "Request option: Words. Default: 50 · Min: 1 · Max: 500", "schema": { "type": "integer", "default": 50, "example": 50, "minimum": 1, "maximum": 500 }, "example": 50 } ], "x-actoki-response-fields": [ "text" ] }, "post": { "tags": [ "Text Tools API" ], "summary": "Generate lorem ipsum.", "operationId": "text_tools_post_v1_text_lorem", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "text_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/text/lorem.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "words": { "type": "integer", "default": 50, "example": 50, "minimum": 1, "maximum": 500, "description": "Request option: Words. Default: 50 · Min: 1 · Max: 500" } }, "additionalProperties": false }, "example": { "words": 50 } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "words": { "type": "integer", "default": 50, "example": 50, "minimum": 1, "maximum": 500, "description": "Request option: Words. Default: 50 · Min: 1 · Max: 500" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "text" ] } }, "/v1/trademarks/search": { "get": { "tags": [ "Trade Mark Registry API" ], "summary": "Search EU trade marks; return an official UK IPO search link where machine access is not licensed.", "operationId": "trademark_registry_get_v1_trademarks_search", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "trademark_registry", "x-actoki-units": 6, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": [], "code": [], "message": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/trademarks/search.php", "parameters": [ { "name": "jurisdiction", "in": "query", "required": false, "description": "Trade-mark jurisdiction. Default: EU · Options: EU, GB, UK, US", "schema": { "type": "string", "enum": [ "EU", "GB", "UK", "US" ], "default": "EU", "example": "EU" }, "example": "EU" }, { "name": "name", "in": "query", "required": true, "description": "Word mark or name to search.", "schema": { "type": "string", "example": "ACTOKI" }, "example": "ACTOKI" }, { "name": "q", "in": "query", "required": false, "description": "Alias for name.", "schema": { "type": "string", "example": "ACTOKI" }, "example": "ACTOKI" }, { "name": "owner", "in": "query", "required": false, "description": "Applicant or owner filter.", "schema": { "type": "string", "example": "Example Ltd" }, "example": "Example Ltd" }, { "name": "status", "in": "query", "required": false, "description": "Provider status filter.", "schema": { "type": "string", "example": "registered" }, "example": "registered" }, { "name": "page", "in": "query", "required": false, "description": "Zero-based result page. Default: 0 · Min: 0", "schema": { "type": "integer", "default": 0, "example": "0", "minimum": 0 }, "example": "0" }, { "name": "per_page", "in": "query", "required": false, "description": "Results per page. Default: 20 · Min: 1 · Max: 100", "schema": { "type": "integer", "default": 20, "example": "20", "minimum": 1, "maximum": 100 }, "example": "20" } ], "x-actoki-response-fields": [ "error", "code", "message" ] }, "post": { "tags": [ "Trade Mark Registry API" ], "summary": "Search EU trade marks; return an official UK IPO search link where machine access is not licensed.", "operationId": "trademark_registry_post_v1_trademarks_search", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "trademark_registry", "x-actoki-units": 6, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": [], "code": [], "message": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/trademarks/search.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "jurisdiction": { "type": "string", "enum": [ "EU", "GB", "UK", "US" ], "default": "EU", "example": "EU", "description": "Trade-mark jurisdiction. Default: EU · Options: EU, GB, UK, US" }, "name": { "type": "string", "example": "ACTOKI", "description": "Word mark or name to search." }, "q": { "type": "string", "example": "ACTOKI", "description": "Alias for name." }, "owner": { "type": "string", "example": "Example Ltd", "description": "Applicant or owner filter." }, "status": { "type": "string", "example": "registered", "description": "Provider status filter." }, "page": { "type": "integer", "default": 0, "example": "0", "minimum": 0, "description": "Zero-based result page. Default: 0 · Min: 0" }, "per_page": { "type": "integer", "default": 20, "example": "20", "minimum": 1, "maximum": 100, "description": "Results per page. Default: 20 · Min: 1 · Max: 100" } }, "additionalProperties": false, "required": [ "name" ] }, "example": { "jurisdiction": "EU", "name": "ACTOKI", "q": "ACTOKI" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "jurisdiction": { "type": "string", "enum": [ "EU", "GB", "UK", "US" ], "default": "EU", "example": "EU", "description": "Trade-mark jurisdiction. Default: EU · Options: EU, GB, UK, US" }, "name": { "type": "string", "example": "ACTOKI", "description": "Word mark or name to search." }, "q": { "type": "string", "example": "ACTOKI", "description": "Alias for name." }, "owner": { "type": "string", "example": "Example Ltd", "description": "Applicant or owner filter." }, "status": { "type": "string", "example": "registered", "description": "Provider status filter." }, "page": { "type": "integer", "default": 0, "example": "0", "minimum": 0, "description": "Zero-based result page. Default: 0 · Min: 0" }, "per_page": { "type": "integer", "default": 20, "example": "20", "minimum": 1, "maximum": 100, "description": "Results per page. Default: 20 · Min: 1 · Max: 100" } }, "additionalProperties": false, "required": [ "name" ] } } } }, "x-actoki-response-fields": [ "error", "code", "message" ] } }, "/v1/trademarks/profile": { "get": { "tags": [ "Trade Mark Registry API" ], "summary": "Retrieve EUIPO or USPTO trade-mark record details.", "operationId": "trademark_registry_get_v1_trademarks_profile", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "trademark_registry", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": [], "code": [], "message": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/trademarks/profile.php", "x-actoki-notes": [ "Use application_number for EU records. Use serial_number or registration_number for US records." ], "description": "- Use application_number for EU records. Use serial_number or registration_number for US records.", "parameters": [ { "name": "jurisdiction", "in": "query", "required": false, "description": "Trade-mark jurisdiction. Default: EU · Options: EU, US", "schema": { "type": "string", "enum": [ "EU", "US" ], "default": "EU", "example": "EU" }, "example": "EU" }, { "name": "application_number", "in": "query", "required": false, "description": "EUIPO application number; required for EU records.", "schema": { "type": "string", "example": "018123456" }, "example": "018123456" }, { "name": "serial_number", "in": "query", "required": false, "description": "USPTO serial number; required for US records when registration_number is omitted.", "schema": { "type": "string", "example": "98765432" }, "example": "98765432" }, { "name": "registration_number", "in": "query", "required": false, "description": "USPTO registration number; alternative to serial_number.", "schema": { "type": "string", "example": "7654321" }, "example": "7654321" } ], "x-actoki-response-fields": [ "error", "code", "message" ] }, "post": { "tags": [ "Trade Mark Registry API" ], "summary": "Retrieve EUIPO or USPTO trade-mark record details.", "operationId": "trademark_registry_post_v1_trademarks_profile", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "trademark_registry", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": [], "code": [], "message": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/trademarks/profile.php", "x-actoki-notes": [ "Use application_number for EU records. Use serial_number or registration_number for US records." ], "description": "- Use application_number for EU records. Use serial_number or registration_number for US records.", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "jurisdiction": { "type": "string", "enum": [ "EU", "US" ], "default": "EU", "example": "EU", "description": "Trade-mark jurisdiction. Default: EU · Options: EU, US" }, "application_number": { "type": "string", "example": "018123456", "description": "EUIPO application number; required for EU records." }, "serial_number": { "type": "string", "example": "98765432", "description": "USPTO serial number; required for US records when registration_number is omitted." }, "registration_number": { "type": "string", "example": "7654321", "description": "USPTO registration number; alternative to serial_number." } }, "additionalProperties": false }, "example": { "jurisdiction": "EU", "application_number": "018123456", "serial_number": "98765432" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "jurisdiction": { "type": "string", "enum": [ "EU", "US" ], "default": "EU", "example": "EU", "description": "Trade-mark jurisdiction. Default: EU · Options: EU, US" }, "application_number": { "type": "string", "example": "018123456", "description": "EUIPO application number; required for EU records." }, "serial_number": { "type": "string", "example": "98765432", "description": "USPTO serial number; required for US records when registration_number is omitted." }, "registration_number": { "type": "string", "example": "7654321", "description": "USPTO registration number; alternative to serial_number." } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "error", "code", "message" ] } }, "/v1/trademarks/sources": { "get": { "tags": [ "Trade Mark Registry API" ], "summary": "List supported official trade-mark providers and integration status.", "operationId": "trademark_registry_get_v1_trademarks_sources", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "trademark_registry", "x-actoki-units": 1, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": [], "code": [], "message": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "query string" ], "x-actoki-source": "httpdocs/v1/trademarks/sources.php", "parameters": [], "x-actoki-response-fields": [ "error", "code", "message" ] } }, "/v1/travel/flight-duration-estimate": { "get": { "tags": [ "Booking & Travel Rules API" ], "summary": "Flight duration estimate", "operationId": "travel_rules_get_v1_travel_flight_duration_estimate", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "travel_rules", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "distance_km": [], "estimated_hours": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/travel/flight-duration-estimate.php", "parameters": [ { "name": "distance_km", "in": "query", "required": false, "description": "Request option: Distance Km. Default: 0", "schema": { "type": "number", "default": 0, "example": 0 }, "example": 0 }, { "name": "from", "in": "query", "required": false, "description": "Request option: From. Default: LHR", "schema": { "type": "string", "default": "LHR", "example": "LHR" }, "example": "LHR" }, { "name": "to", "in": "query", "required": false, "description": "Request option: To. Default: JFK", "schema": { "type": "string", "default": "JFK", "example": "JFK" }, "example": "JFK" } ], "x-actoki-response-fields": [ "distance_km", "estimated_hours" ] }, "post": { "tags": [ "Booking & Travel Rules API" ], "summary": "Flight duration estimate", "operationId": "travel_rules_post_v1_travel_flight_duration_estimate", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "travel_rules", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "distance_km": [], "estimated_hours": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/travel/flight-duration-estimate.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "distance_km": { "type": "number", "default": 0, "example": 0, "description": "Request option: Distance Km. Default: 0" }, "from": { "type": "string", "default": "LHR", "example": "LHR", "description": "Request option: From. Default: LHR" }, "to": { "type": "string", "default": "JFK", "example": "JFK", "description": "Request option: To. Default: JFK" } }, "additionalProperties": false }, "example": { "distance_km": 0, "from": "LHR", "to": "JFK" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "distance_km": { "type": "number", "default": 0, "example": 0, "description": "Request option: Distance Km. Default: 0" }, "from": { "type": "string", "default": "LHR", "example": "LHR", "description": "Request option: From. Default: LHR" }, "to": { "type": "string", "default": "JFK", "example": "JFK", "description": "Request option: To. Default: JFK" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "distance_km", "estimated_hours" ] } }, "/v1/travel/time-at-destination": { "get": { "tags": [ "Booking & Travel Rules API" ], "summary": "Destination local time", "operationId": "travel_rules_get_v1_travel_time_at_destination", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "travel_rules", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/travel/time-at-destination.php", "parameters": [ { "name": "timezone", "in": "query", "required": false, "description": "IANA timezone identifier. Default: Europe/London", "schema": { "type": "string", "default": "Europe/London", "example": "Europe/London" }, "example": "Europe/London" } ] }, "post": { "tags": [ "Booking & Travel Rules API" ], "summary": "Destination local time", "operationId": "travel_rules_post_v1_travel_time_at_destination", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "travel_rules", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/travel/time-at-destination.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "timezone": { "type": "string", "default": "Europe/London", "example": "Europe/London", "description": "IANA timezone identifier. Default: Europe/London" } }, "additionalProperties": false }, "example": { "timezone": "Europe/London" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "timezone": { "type": "string", "default": "Europe/London", "example": "Europe/London", "description": "IANA timezone identifier. Default: Europe/London" } }, "additionalProperties": false } } } } } }, "/v1/travel/jetlag-window": { "get": { "tags": [ "Booking & Travel Rules API" ], "summary": "Jetlag planning helper", "operationId": "travel_rules_get_v1_travel_jetlag_window", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "travel_rules", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "timezone_difference_hours": [], "adjustment_days": [], "advice": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/travel/jetlag-window.php", "parameters": [ { "name": "timezone_difference_hours", "in": "query", "required": false, "description": "Request option: Timezone Difference Hours. Default: 5 · Min: -14 · Max: 14", "schema": { "type": "integer", "default": 5, "example": 5, "minimum": -14, "maximum": 14 }, "example": 5 } ], "x-actoki-response-fields": [ "timezone_difference_hours", "adjustment_days", "advice" ] }, "post": { "tags": [ "Booking & Travel Rules API" ], "summary": "Jetlag planning helper", "operationId": "travel_rules_post_v1_travel_jetlag_window", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "travel_rules", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "timezone_difference_hours": [], "adjustment_days": [], "advice": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/travel/jetlag-window.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "timezone_difference_hours": { "type": "integer", "default": 5, "example": 5, "minimum": -14, "maximum": 14, "description": "Request option: Timezone Difference Hours. Default: 5 · Min: -14 · Max: 14" } }, "additionalProperties": false }, "example": { "timezone_difference_hours": 5 } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "timezone_difference_hours": { "type": "integer", "default": 5, "example": 5, "minimum": -14, "maximum": 14, "description": "Request option: Timezone Difference Hours. Default: 5 · Min: -14 · Max: 14" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "timezone_difference_hours", "adjustment_days", "advice" ] } }, "/v1/travel/airport": { "get": { "tags": [ "Travel & Country Utilities API" ], "summary": "Airport code lookup", "operationId": "travel_tools_get_v1_travel_airport", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "travel_tools", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "LHR": [], "name": [], "city": [], "country": [], "lat": [], "lng": [], "LGW": [], "JFK": [], "DXB": [], "code": [], "airport": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/travel/airport.php", "parameters": [ { "name": "code", "in": "query", "required": false, "description": "Short code or identifier. Default: LHR · Maximum 4 characters", "schema": { "type": "string", "default": "LHR", "example": "LHR", "maxLength": 4 }, "example": "LHR" } ], "x-actoki-response-fields": [ "LHR", "name", "city", "country", "lat", "lng", "LGW", "JFK", "DXB", "code", "airport" ] }, "post": { "tags": [ "Travel & Country Utilities API" ], "summary": "Airport code lookup", "operationId": "travel_tools_post_v1_travel_airport", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "travel_tools", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "LHR": [], "name": [], "city": [], "country": [], "lat": [], "lng": [], "LGW": [], "JFK": [], "DXB": [], "code": [], "airport": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/travel/airport.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "default": "LHR", "example": "LHR", "maxLength": 4, "description": "Short code or identifier. Default: LHR · Maximum 4 characters" } }, "additionalProperties": false }, "example": { "code": "LHR" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "code": { "type": "string", "default": "LHR", "example": "LHR", "maxLength": 4, "description": "Short code or identifier. Default: LHR · Maximum 4 characters" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "LHR", "name", "city", "country", "lat", "lng", "LGW", "JFK", "DXB", "code", "airport" ] } }, "/v1/travel/airport-distance": { "get": { "tags": [ "Travel & Country Utilities API" ], "summary": "Distance between airports", "operationId": "travel_tools_get_v1_travel_airport_distance", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "travel_tools", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "from": [], "to": [], "distance_km": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/travel/airport-distance.php", "parameters": [ { "name": "from", "in": "query", "required": false, "description": "Request option: From. Default: LHR · Maximum 4 characters", "schema": { "type": "string", "default": "LHR", "example": "LHR", "maxLength": 4 }, "example": "LHR" }, { "name": "to", "in": "query", "required": false, "description": "Request option: To. Default: JFK · Maximum 4 characters", "schema": { "type": "string", "default": "JFK", "example": "JFK", "maxLength": 4 }, "example": "JFK" }, { "name": "code", "in": "query", "required": false, "description": "Short code or identifier.", "schema": { "type": "string", "example": "example" }, "example": "example" } ], "x-actoki-response-fields": [ "from", "to", "distance_km" ] }, "post": { "tags": [ "Travel & Country Utilities API" ], "summary": "Distance between airports", "operationId": "travel_tools_post_v1_travel_airport_distance", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "travel_tools", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "from": [], "to": [], "distance_km": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/travel/airport-distance.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "from": { "type": "string", "default": "LHR", "example": "LHR", "maxLength": 4, "description": "Request option: From. Default: LHR · Maximum 4 characters" }, "to": { "type": "string", "default": "JFK", "example": "JFK", "maxLength": 4, "description": "Request option: To. Default: JFK · Maximum 4 characters" }, "code": { "type": "string", "example": "example", "description": "Short code or identifier." } }, "additionalProperties": false }, "example": { "from": "LHR", "to": "JFK", "code": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "from": { "type": "string", "default": "LHR", "example": "LHR", "maxLength": 4, "description": "Request option: From. Default: LHR · Maximum 4 characters" }, "to": { "type": "string", "default": "JFK", "example": "JFK", "maxLength": 4, "description": "Request option: To. Default: JFK · Maximum 4 characters" }, "code": { "type": "string", "example": "example", "description": "Short code or identifier." } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "from", "to", "distance_km" ] } }, "/v1/travel/timezone": { "get": { "tags": [ "Travel & Country Utilities API" ], "summary": "Travel timezone lookup", "operationId": "travel_tools_get_v1_travel_timezone", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "travel_tools", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "timezone": [], "now": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/travel/timezone.php", "parameters": [ { "name": "timezone", "in": "query", "required": false, "description": "Request option: Timezone. Default: Europe/London", "schema": { "type": "string", "default": "Europe/London", "example": "Europe/London" }, "example": "Europe/London" } ], "x-actoki-response-fields": [ "timezone", "now" ] }, "post": { "tags": [ "Travel & Country Utilities API" ], "summary": "Travel timezone lookup", "operationId": "travel_tools_post_v1_travel_timezone", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "travel_tools", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "timezone": [], "now": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/travel/timezone.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "timezone": { "type": "string", "default": "Europe/London", "example": "Europe/London", "description": "Request option: Timezone. Default: Europe/London" } }, "additionalProperties": false }, "example": { "timezone": "Europe/London" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "timezone": { "type": "string", "default": "Europe/London", "example": "Europe/London", "description": "Request option: Timezone. Default: Europe/London" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "timezone", "now" ] } }, "/v1/travel/country": { "get": { "tags": [ "Travel & Country Utilities API" ], "summary": "Country information", "operationId": "travel_tools_get_v1_travel_country", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "travel_tools", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "GB": [], "name": [], "currency": [], "dial_code": [], "US": [], "AE": [], "code": [], "country": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/travel/country.php", "parameters": [ { "name": "code", "in": "query", "required": false, "description": "Short code or identifier. Default: GB · Maximum 2 characters", "schema": { "type": "string", "default": "GB", "example": "GB", "maxLength": 2 }, "example": "GB" } ], "x-actoki-response-fields": [ "GB", "name", "currency", "dial_code", "US", "AE", "code", "country" ] }, "post": { "tags": [ "Travel & Country Utilities API" ], "summary": "Country information", "operationId": "travel_tools_post_v1_travel_country", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "travel_tools", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "GB": [], "name": [], "currency": [], "dial_code": [], "US": [], "AE": [], "code": [], "country": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/travel/country.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "default": "GB", "example": "GB", "maxLength": 2, "description": "Short code or identifier. Default: GB · Maximum 2 characters" } }, "additionalProperties": false }, "example": { "code": "GB" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "code": { "type": "string", "default": "GB", "example": "GB", "maxLength": 2, "description": "Short code or identifier. Default: GB · Maximum 2 characters" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "GB", "name", "currency", "dial_code", "US", "AE", "code", "country" ] } }, "/v1/travel/dial-code": { "get": { "tags": [ "Travel & Country Utilities API" ], "summary": "Country dial code", "operationId": "travel_tools_get_v1_travel_dial_code", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "travel_tools", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "value": [], "country": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/travel/dial-code.php", "parameters": [ { "name": "code", "in": "query", "required": false, "description": "ISO 3166-1 alpha-2 country code. Default: GB · Maximum 2 characters", "schema": { "type": "string", "default": "GB", "example": "GB", "maxLength": 2 }, "example": "GB" } ], "x-actoki-response-fields": [ "value", "country" ] }, "post": { "tags": [ "Travel & Country Utilities API" ], "summary": "Country dial code", "operationId": "travel_tools_post_v1_travel_dial_code", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "travel_tools", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "value": [], "country": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/travel/dial-code.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "default": "GB", "example": "GB", "maxLength": 2, "description": "ISO 3166-1 alpha-2 country code. Default: GB · Maximum 2 characters" } }, "additionalProperties": false }, "example": { "code": "GB" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "code": { "type": "string", "default": "GB", "example": "GB", "maxLength": 2, "description": "ISO 3166-1 alpha-2 country code. Default: GB · Maximum 2 characters" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "value", "country" ] } }, "/v1/travel/currency": { "get": { "tags": [ "Travel & Country Utilities API" ], "summary": "Country currency", "operationId": "travel_tools_get_v1_travel_currency", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "travel_tools", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "value": [], "country": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/travel/currency.php", "parameters": [ { "name": "code", "in": "query", "required": false, "description": "ISO 3166-1 alpha-2 country code. Default: GB · Maximum 2 characters", "schema": { "type": "string", "default": "GB", "example": "GB", "maxLength": 2 }, "example": "GB" } ], "x-actoki-response-fields": [ "value", "country" ] }, "post": { "tags": [ "Travel & Country Utilities API" ], "summary": "Country currency", "operationId": "travel_tools_post_v1_travel_currency", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "travel_tools", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "value": [], "country": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/travel/currency.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "default": "GB", "example": "GB", "maxLength": 2, "description": "ISO 3166-1 alpha-2 country code. Default: GB · Maximum 2 characters" } }, "additionalProperties": false }, "example": { "code": "GB" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "code": { "type": "string", "default": "GB", "example": "GB", "maxLength": 2, "description": "ISO 3166-1 alpha-2 country code. Default: GB · Maximum 2 characters" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "value", "country" ] } }, "/v1/url/safety": { "get": { "tags": [ "URL Safety & Preview API" ], "summary": "Basic URL safety score", "operationId": "url_tools_get_v1_url_safety", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "url_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "risk": [], "signals": [], "url": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/url/safety.php", "parameters": [ { "name": "url", "in": "query", "required": true, "description": "Absolute HTTP or HTTPS URL.", "schema": { "type": "string", "example": "https://example.com" }, "example": "https://example.com" } ], "x-actoki-response-fields": [ "risk", "signals", "url" ] }, "post": { "tags": [ "URL Safety & Preview API" ], "summary": "Basic URL safety score", "operationId": "url_tools_post_v1_url_safety", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "url_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "risk": [], "signals": [], "url": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/url/safety.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "example": "https://example.com", "description": "Absolute HTTP or HTTPS URL." } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://example.com" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "url": { "type": "string", "example": "https://example.com", "description": "Absolute HTTP or HTTPS URL." } }, "additionalProperties": false, "required": [ "url" ] } } } }, "x-actoki-response-fields": [ "risk", "signals", "url" ] } }, "/v1/url/utm-builder": { "get": { "tags": [ "URL Safety & Preview API" ], "summary": "UTM URL builder", "operationId": "url_tools_get_v1_url_utm_builder", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "url_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "utm_source": [], "utm_medium": [], "utm_campaign": [], "url": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/url/utm-builder.php", "parameters": [ { "name": "url", "in": "query", "required": true, "description": "Absolute HTTP or HTTPS URL.", "schema": { "type": "string", "example": "https://example.com" }, "example": "https://example.com" }, { "name": "source", "in": "query", "required": false, "description": "Request option: Source. Default: actoki", "schema": { "type": "string", "default": "actoki", "example": "actoki" }, "example": "actoki" }, { "name": "medium", "in": "query", "required": false, "description": "Request option: Medium. Default: api", "schema": { "type": "string", "default": "api", "example": "api" }, "example": "api" }, { "name": "campaign", "in": "query", "required": false, "description": "Request option: Campaign. Default: campaign", "schema": { "type": "string", "default": "campaign", "example": "campaign" }, "example": "campaign" } ], "x-actoki-response-fields": [ "utm_source", "utm_medium", "utm_campaign", "url" ] }, "post": { "tags": [ "URL Safety & Preview API" ], "summary": "UTM URL builder", "operationId": "url_tools_post_v1_url_utm_builder", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "url_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "utm_source": [], "utm_medium": [], "utm_campaign": [], "url": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/url/utm-builder.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "example": "https://example.com", "description": "Absolute HTTP or HTTPS URL." }, "source": { "type": "string", "default": "actoki", "example": "actoki", "description": "Request option: Source. Default: actoki" }, "medium": { "type": "string", "default": "api", "example": "api", "description": "Request option: Medium. Default: api" }, "campaign": { "type": "string", "default": "campaign", "example": "campaign", "description": "Request option: Campaign. Default: campaign" } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://example.com", "source": "actoki", "medium": "api" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "url": { "type": "string", "example": "https://example.com", "description": "Absolute HTTP or HTTPS URL." }, "source": { "type": "string", "default": "actoki", "example": "actoki", "description": "Request option: Source. Default: actoki" }, "medium": { "type": "string", "default": "api", "example": "api", "description": "Request option: Medium. Default: api" }, "campaign": { "type": "string", "default": "campaign", "example": "campaign", "description": "Request option: Campaign. Default: campaign" } }, "additionalProperties": false, "required": [ "url" ] } } } }, "x-actoki-response-fields": [ "utm_source", "utm_medium", "utm_campaign", "url" ] } }, "/v1/url/utm-cleaner": { "get": { "tags": [ "URL Safety & Preview API" ], "summary": "Remove tracking parameters", "operationId": "url_tools_get_v1_url_utm_cleaner", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "url_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/url/utm-cleaner.php", "parameters": [ { "name": "url", "in": "query", "required": true, "description": "Absolute HTTP or HTTPS URL.", "schema": { "type": "string", "example": "https://example.com" }, "example": "https://example.com" } ], "x-actoki-response-fields": [ "url" ] }, "post": { "tags": [ "URL Safety & Preview API" ], "summary": "Remove tracking parameters", "operationId": "url_tools_post_v1_url_utm_cleaner", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "url_tools", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/url/utm-cleaner.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "example": "https://example.com", "description": "Absolute HTTP or HTTPS URL." } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://example.com" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "url": { "type": "string", "example": "https://example.com", "description": "Absolute HTTP or HTTPS URL." } }, "additionalProperties": false, "required": [ "url" ] } } } }, "x-actoki-response-fields": [ "url" ] } }, "/v1/validate/email": { "get": { "tags": [ "Form Validation API" ], "summary": "Validate email format", "operationId": "validation_get_v1_validate_email", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "validation", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/validate/email.php", "parameters": [ { "name": "email", "in": "query", "required": false, "description": "Email address. Default:", "schema": { "type": "string", "default": "", "example": "user@example.com" }, "example": "user@example.com" } ], "x-actoki-response-fields": [ "valid" ] }, "post": { "tags": [ "Form Validation API" ], "summary": "Validate email format", "operationId": "validation_post_v1_validate_email", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "validation", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/validate/email.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "default": "", "example": "user@example.com", "description": "Email address. Default:" } }, "additionalProperties": false }, "example": { "email": "user@example.com" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "email": { "type": "string", "default": "", "example": "user@example.com", "description": "Email address. Default:" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "valid" ] } }, "/v1/validate/phone": { "get": { "tags": [ "Form Validation API" ], "summary": "Validate phone format", "operationId": "validation_get_v1_validate_phone", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "validation", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/validate/phone.php", "parameters": [ { "name": "phone", "in": "query", "required": false, "description": "Telephone number. Default:", "schema": { "type": "string", "default": "", "example": "+442079460000" }, "example": "+442079460000" }, { "name": "country", "in": "query", "required": false, "description": "ISO country code. Default: GB", "schema": { "type": "string", "default": "GB", "example": "GB" }, "example": "GB" } ] }, "post": { "tags": [ "Form Validation API" ], "summary": "Validate phone format", "operationId": "validation_post_v1_validate_phone", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "validation", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/validate/phone.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "phone": { "type": "string", "default": "", "example": "+442079460000", "description": "Telephone number. Default:" }, "country": { "type": "string", "default": "GB", "example": "GB", "description": "ISO country code. Default: GB" } }, "additionalProperties": false }, "example": { "phone": "+442079460000", "country": "GB" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "phone": { "type": "string", "default": "", "example": "+442079460000", "description": "Telephone number. Default:" }, "country": { "type": "string", "default": "GB", "example": "GB", "description": "ISO country code. Default: GB" } }, "additionalProperties": false } } } } } }, "/v1/validate/url": { "get": { "tags": [ "Form Validation API" ], "summary": "Validate URL", "operationId": "validation_get_v1_validate_url", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "validation", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/validate/url.php", "parameters": [ { "name": "url", "in": "query", "required": false, "description": "Absolute HTTP or HTTPS URL. Default:", "schema": { "type": "string", "default": "", "example": "https://example.com" }, "example": "https://example.com" } ], "x-actoki-response-fields": [ "valid" ] }, "post": { "tags": [ "Form Validation API" ], "summary": "Validate URL", "operationId": "validation_post_v1_validate_url", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "validation", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/validate/url.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "default": "", "example": "https://example.com", "description": "Absolute HTTP or HTTPS URL. Default:" } }, "additionalProperties": false }, "example": { "url": "https://example.com" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "url": { "type": "string", "default": "", "example": "https://example.com", "description": "Absolute HTTP or HTTPS URL. Default:" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "valid" ] } }, "/v1/validate/domain": { "get": { "tags": [ "Form Validation API" ], "summary": "Validate domain and DNS", "operationId": "validation_get_v1_validate_domain", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "validation", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": [], "valid": [], "has_dns": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/validate/domain.php", "parameters": [ { "name": "domain", "in": "query", "required": false, "description": "Domain name without a path. Default:", "schema": { "type": "string", "default": "", "example": "example.com" }, "example": "example.com" } ], "x-actoki-response-fields": [ "domain", "valid", "has_dns" ] }, "post": { "tags": [ "Form Validation API" ], "summary": "Validate domain and DNS", "operationId": "validation_post_v1_validate_domain", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "validation", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": [], "valid": [], "has_dns": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/validate/domain.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "default": "", "example": "example.com", "description": "Domain name without a path. Default:" } }, "additionalProperties": false }, "example": { "domain": "example.com" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "default": "", "example": "example.com", "description": "Domain name without a path. Default:" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "domain", "valid", "has_dns" ] } }, "/v1/validate/postcode": { "get": { "tags": [ "Form Validation API" ], "summary": "Validate UK postcode", "operationId": "validation_get_v1_validate_postcode", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "validation", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": [], "country": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/validate/postcode.php", "parameters": [ { "name": "postcode", "in": "query", "required": false, "description": "Request option: Postcode. Default:", "schema": { "type": "string", "default": "", "example": "example" }, "example": "example" } ], "x-actoki-response-fields": [ "valid", "country" ] }, "post": { "tags": [ "Form Validation API" ], "summary": "Validate UK postcode", "operationId": "validation_post_v1_validate_postcode", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "validation", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": [], "country": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/validate/postcode.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "postcode": { "type": "string", "default": "", "example": "example", "description": "Request option: Postcode. Default:" } }, "additionalProperties": false }, "example": { "postcode": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "postcode": { "type": "string", "default": "", "example": "example", "description": "Request option: Postcode. Default:" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "valid", "country" ] } }, "/v1/validate/password-strength": { "get": { "tags": [ "Form Validation API" ], "summary": "Password strength score", "operationId": "validation_get_v1_validate_password_strength", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "validation", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "score": [], "strength": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/validate/password-strength.php", "parameters": [ { "name": "password", "in": "query", "required": false, "description": "Request option: Password. Default: · Maximum 500 characters", "schema": { "type": "string", "default": "", "example": "example", "maxLength": 500 }, "example": "example" } ], "x-actoki-response-fields": [ "score", "strength" ] }, "post": { "tags": [ "Form Validation API" ], "summary": "Password strength score", "operationId": "validation_post_v1_validate_password_strength", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "validation", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "score": [], "strength": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/validate/password-strength.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "password": { "type": "string", "default": "", "example": "example", "maxLength": 500, "description": "Request option: Password. Default: · Maximum 500 characters" } }, "additionalProperties": false }, "example": { "password": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "password": { "type": "string", "default": "", "example": "example", "maxLength": 500, "description": "Request option: Password. Default: · Maximum 500 characters" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "score", "strength" ] } }, "/v1/validate/vat": { "get": { "tags": [ "Form Validation API" ], "summary": "VAT format check", "operationId": "validation_get_v1_validate_vat", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "validation", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/validate/vat.php", "parameters": [ { "name": "vat", "in": "query", "required": true, "description": "VAT registration number to validate. Maximum 30 characters", "schema": { "type": "string", "example": "GB123456789", "maxLength": 30 }, "example": "GB123456789" } ] }, "post": { "tags": [ "Form Validation API" ], "summary": "VAT format check", "operationId": "validation_post_v1_validate_vat", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "validation", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/validate/vat.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "vat": { "type": "string", "example": "GB123456789", "maxLength": 30, "description": "VAT registration number to validate. Maximum 30 characters" } }, "additionalProperties": false, "required": [ "vat" ] }, "example": { "vat": "GB123456789" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "vat": { "type": "string", "example": "GB123456789", "maxLength": 30, "description": "VAT registration number to validate. Maximum 30 characters" } }, "additionalProperties": false, "required": [ "vat" ] } } } } } }, "/v1/validate/iban": { "get": { "tags": [ "Form Validation API" ], "summary": "IBAN format check", "operationId": "validation_get_v1_validate_iban", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "validation", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/validate/iban.php", "parameters": [ { "name": "iban", "in": "query", "required": true, "description": "IBAN to validate; spaces are ignored. Maximum 60 characters", "schema": { "type": "string", "example": "GB82 WEST 1234 5698 7654 32", "maxLength": 60 }, "example": "GB82 WEST 1234 5698 7654 32" } ] }, "post": { "tags": [ "Form Validation API" ], "summary": "IBAN format check", "operationId": "validation_post_v1_validate_iban", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "validation", "x-actoki-units": 5, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/validate/iban.php", "requestBody": { "required": true, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "iban": { "type": "string", "example": "GB82 WEST 1234 5698 7654 32", "maxLength": 60, "description": "IBAN to validate; spaces are ignored. Maximum 60 characters" } }, "additionalProperties": false, "required": [ "iban" ] }, "example": { "iban": "GB82 WEST 1234 5698 7654 32" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "iban": { "type": "string", "example": "GB82 WEST 1234 5698 7654 32", "maxLength": 60, "description": "IBAN to validate; spaces are ignored. Maximum 60 characters" } }, "additionalProperties": false, "required": [ "iban" ] } } } } } }, "/v1/vat/check": { "get": { "tags": [ "VAT API" ], "summary": "Example VAT number format check.", "operationId": "vat_get_v1_vat_check", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "vat", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "vat": [], "format_valid": [], "message": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/vat-check.php", "parameters": [ { "name": "vat", "in": "query", "required": false, "description": "Request option: Vat.", "schema": { "type": "string", "example": "example" }, "example": "example" } ], "x-actoki-response-fields": [ "vat", "format_valid", "message" ] }, "post": { "tags": [ "VAT API" ], "summary": "Example VAT number format check.", "operationId": "vat_post_v1_vat_check", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "vat", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "vat": [], "format_valid": [], "message": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/vat-check.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "vat": { "type": "string", "example": "example", "description": "Request option: Vat." } }, "additionalProperties": false }, "example": { "vat": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "vat": { "type": "string", "example": "example", "description": "Request option: Vat." } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "vat", "format_valid", "message" ] } }, "/v1/vat/calculate": { "get": { "tags": [ "VAT API" ], "summary": "Example VAT calculation endpoint.", "operationId": "vat_get_v1_vat_calculate", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "vat", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "net": [], "rate": [], "vat": [], "gross": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/vat-calculate.php", "parameters": [ { "name": "net", "in": "query", "required": false, "description": "Request option: Net.", "schema": { "type": "string", "example": "example" }, "example": "example" }, { "name": "rate", "in": "query", "required": false, "description": "Request option: Rate.", "schema": { "type": "string", "example": "example" }, "example": "example" } ], "x-actoki-response-fields": [ "net", "rate", "vat", "gross" ] }, "post": { "tags": [ "VAT API" ], "summary": "Example VAT calculation endpoint.", "operationId": "vat_post_v1_vat_calculate", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "vat", "x-actoki-units": 10, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "net": [], "rate": [], "vat": [], "gross": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/vat-calculate.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "net": { "type": "string", "example": "example", "description": "Request option: Net." }, "rate": { "type": "string", "example": "example", "description": "Request option: Rate." } }, "additionalProperties": false }, "example": { "net": "example", "rate": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "net": { "type": "string", "example": "example", "description": "Request option: Net." }, "rate": { "type": "string", "example": "example", "description": "Request option: Rate." } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "net", "rate", "vat", "gross" ] } }, "/v1/monitor/http": { "get": { "tags": [ "Website Monitoring API" ], "summary": "HTTP status and response time.", "operationId": "website_monitoring_get_v1_monitor_http", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "website_monitoring", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/monitor/http.php", "parameters": [ { "name": "url", "in": "query", "required": false, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters · Options: /v1/monitor/http, /v1/monitor/page-speed-basic", "schema": { "type": "string", "enum": [ "/v1/monitor/http", "/v1/monitor/page-speed-basic" ], "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000 }, "example": "https://actoki.com" } ] }, "post": { "tags": [ "Website Monitoring API" ], "summary": "HTTP status and response time.", "operationId": "website_monitoring_post_v1_monitor_http", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "website_monitoring", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/monitor/http.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "enum": [ "/v1/monitor/http", "/v1/monitor/page-speed-basic" ], "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters · Options: /v1/monitor/http, /v1/monitor/page-speed-basic" } }, "additionalProperties": false }, "example": { "url": "https://actoki.com" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "url": { "type": "string", "enum": [ "/v1/monitor/http", "/v1/monitor/page-speed-basic" ], "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters · Options: /v1/monitor/http, /v1/monitor/page-speed-basic" } }, "additionalProperties": false } } } } } }, "/v1/monitor/ssl": { "get": { "tags": [ "Website Monitoring API" ], "summary": "TLS certificate check: validity, expiry, hostname match, issuer, chain and protocol.", "operationId": "website_monitoring_get_v1_monitor_ssl", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "website_monitoring", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": [], "hint": [], "message": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/monitor/ssl.php", "parameters": [ { "name": "host", "in": "query", "required": false, "description": "Request option: Host.", "schema": { "type": "string", "example": "example" }, "example": "example" }, { "name": "domain", "in": "query", "required": false, "description": "Domain name without a path.", "schema": { "type": "string", "example": "example.com" }, "example": "example.com" }, { "name": "url", "in": "query", "required": false, "description": "Absolute HTTP or HTTPS URL.", "schema": { "type": "string", "example": "https://example.com" }, "example": "https://example.com" }, { "name": "port", "in": "query", "required": false, "description": "Request option: Port.", "schema": { "type": "string", "example": "example" }, "example": "example" }, { "name": "timeout", "in": "query", "required": false, "description": "Request option: Timeout.", "schema": { "type": "string", "example": "example" }, "example": "example" } ], "x-actoki-response-fields": [ "error", "hint", "message" ] }, "post": { "tags": [ "Website Monitoring API" ], "summary": "TLS certificate check: validity, expiry, hostname match, issuer, chain and protocol.", "operationId": "website_monitoring_post_v1_monitor_ssl", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "website_monitoring", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": [], "hint": [], "message": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/monitor/ssl.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "host": { "type": "string", "example": "example", "description": "Request option: Host." }, "domain": { "type": "string", "example": "example.com", "description": "Domain name without a path." }, "url": { "type": "string", "example": "https://example.com", "description": "Absolute HTTP or HTTPS URL." }, "port": { "type": "string", "example": "example", "description": "Request option: Port." }, "timeout": { "type": "string", "example": "example", "description": "Request option: Timeout." } }, "additionalProperties": false }, "example": { "host": "example", "domain": "example.com", "url": "https://example.com" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "host": { "type": "string", "example": "example", "description": "Request option: Host." }, "domain": { "type": "string", "example": "example.com", "description": "Domain name without a path." }, "url": { "type": "string", "example": "https://example.com", "description": "Absolute HTTP or HTTPS URL." }, "port": { "type": "string", "example": "example", "description": "Request option: Port." }, "timeout": { "type": "string", "example": "example", "description": "Request option: Timeout." } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "error", "hint", "message" ] } }, "/v1/monitor/ssl-batch": { "post": { "tags": [ "Website Monitoring API" ], "summary": "Check TLS certificates for up to 25 hosts in one call (charged per host).", "operationId": "website_monitoring_post_v1_monitor_ssl_batch", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "website_monitoring", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": [], "hint": [], "max": [], "host": [], "reachable": [], "count": [], "summary": [], "valid": [], "invalid": [], "unreachable": [], "expiring_within_30_days": [], "results": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/monitor/ssl-batch.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "hosts": { "type": "string", "example": "example", "description": "Request option: Hosts." }, "timeout": { "type": "string", "example": "example", "description": "Request option: Timeout." }, "port": { "type": "string", "example": "example", "description": "Request option: Port." } }, "additionalProperties": false }, "example": { "hosts": "example", "timeout": "example", "port": "example" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "hosts": { "type": "string", "example": "example", "description": "Request option: Hosts." }, "timeout": { "type": "string", "example": "example", "description": "Request option: Timeout." }, "port": { "type": "string", "example": "example", "description": "Request option: Port." } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "error", "hint", "max", "host", "reachable", "count", "summary", "valid", "invalid", "unreachable", "expiring_within_30_days", "results" ] } }, "/v1/monitor/dns": { "get": { "tags": [ "Website Monitoring API" ], "summary": "DNS check.", "operationId": "website_monitoring_get_v1_monitor_dns", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "website_monitoring", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": [], "records": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/monitor/dns.php", "parameters": [ { "name": "domain", "in": "query", "required": false, "description": "Domain name without a path. Default: actoki.com · Maximum 255 characters", "schema": { "type": "string", "default": "actoki.com", "example": "actoki.com", "maxLength": 255 }, "example": "actoki.com" } ], "x-actoki-response-fields": [ "domain", "records" ] }, "post": { "tags": [ "Website Monitoring API" ], "summary": "DNS check.", "operationId": "website_monitoring_post_v1_monitor_dns", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "website_monitoring", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": [], "records": [] }, "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/monitor/dns.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "default": "actoki.com", "example": "actoki.com", "maxLength": 255, "description": "Domain name without a path. Default: actoki.com · Maximum 255 characters" } }, "additionalProperties": false }, "example": { "domain": "actoki.com" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "default": "actoki.com", "example": "actoki.com", "maxLength": 255, "description": "Domain name without a path. Default: actoki.com · Maximum 255 characters" } }, "additionalProperties": false } } } }, "x-actoki-response-fields": [ "domain", "records" ] } }, "/v1/monitor/page-speed-basic": { "get": { "tags": [ "Website Monitoring API" ], "summary": "Basic page speed timing.", "operationId": "website_monitoring_get_v1_monitor_page_speed_basic", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "website_monitoring", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/monitor/page-speed-basic.php", "parameters": [ { "name": "url", "in": "query", "required": false, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters · Options: /v1/monitor/http, /v1/monitor/page-speed-basic", "schema": { "type": "string", "enum": [ "/v1/monitor/http", "/v1/monitor/page-speed-basic" ], "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000 }, "example": "https://actoki.com" } ] }, "post": { "tags": [ "Website Monitoring API" ], "summary": "Basic page speed timing.", "operationId": "website_monitoring_post_v1_monitor_page_speed_basic", "security": [ { "bearerAuth": [] } ], "x-actoki-service": "website_monitoring", "x-actoki-units": 15, "x-actoki-maturity": "production", "x-actoki-production-ready": true, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorised" }, "403": { "$ref": "#/components/responses/Forbidden" }, "402": { "$ref": "#/components/responses/InsufficientCredits" }, "422": { "$ref": "#/components/responses/ValidationFailed" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/ServerError" } }, "x-actoki-request-options-complete": true, "x-actoki-request-formats": [ "application/json", "application/x-www-form-urlencoded" ], "x-actoki-source": "httpdocs/v1/monitor/page-speed-basic.php", "requestBody": { "required": false, "description": "Supported request fields for this operation. Unknown fields are not part of the documented contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "enum": [ "/v1/monitor/http", "/v1/monitor/page-speed-basic" ], "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters · Options: /v1/monitor/http, /v1/monitor/page-speed-basic" } }, "additionalProperties": false }, "example": { "url": "https://actoki.com" } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "url": { "type": "string", "enum": [ "/v1/monitor/http", "/v1/monitor/page-speed-basic" ], "default": "https://actoki.com", "example": "https://actoki.com", "maxLength": 2000, "description": "Absolute HTTP or HTTPS URL. Default: https://actoki.com · Maximum 2000 characters · Options: /v1/monitor/http, /v1/monitor/page-speed-basic" } }, "additionalProperties": false } } } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "API key", "description": "Keep permanent API keys in a server-side secret store." } }, "schemas": { "JsonResponse": { "type": "object", "additionalProperties": true }, "Error": { "type": "object", "properties": { "ok": { "type": "boolean", "const": false }, "error": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "message" ], "additionalProperties": true } }, "responses": { "BadRequest": { "description": "Invalid or incomplete request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "Unauthorised": { "description": "Missing, invalid or revoked credentials.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "Forbidden": { "description": "The account or key lacks permission for this service.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "InsufficientCredits": { "description": "The account does not have enough credits for this request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "ValidationFailed": { "description": "One or more documented request fields failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "RateLimited": { "description": "The request was rate limited. Respect Retry-After when supplied.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Suggested delay in seconds." } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "ServerError": { "description": "A server or upstream dependency failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "security": [ { "bearerAuth": [] } ] }