REST API

REST API faithful to the code.

Base URL: https://api.aifoxapp.com/api/v1

Authentication

Use a Bearer JWT or an API key where indicated.

JWT example

Authorization: Bearer $AIFOX_TOKEN

API key example

X-API-Key: $AIFOX_API_KEY

Auth

POST/auth/register

Creates a user and organization.

Full URL: https://api.aifoxapp.com/api/v1/auth/register
Access: Public
Inputs: email, password, full_name?, org_name?, terms_accepted
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X POST 'https://api.aifoxapp.com/api/v1/auth/register' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

POST/auth/login

Returns a Bearer access token.

Full URL: https://api.aifoxapp.com/api/v1/auth/login
Access: Public
Inputs: application/x-www-form-urlencoded: username, password
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X POST 'https://api.aifoxapp.com/api/v1/auth/login' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

GET/auth/me

Returns the current user.

Full URL: https://api.aifoxapp.com/api/v1/auth/me
Access: JWT
Inputs: —
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X GET 'https://api.aifoxapp.com/api/v1/auth/me' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

GET/auth/org

Returns the current organization.

Full URL: https://api.aifoxapp.com/api/v1/auth/org
Access: JWT
Inputs: —
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X GET 'https://api.aifoxapp.com/api/v1/auth/org' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

Apps

GET/apps/

Lists organization apps.

Full URL: https://api.aifoxapp.com/api/v1/apps/
Access: JWT or API key
Inputs: —
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X GET 'https://api.aifoxapp.com/api/v1/apps/' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

POST/apps/

Creates an app.

Full URL: https://api.aifoxapp.com/api/v1/apps/
Access: JWT or API key
Inputs: name, package_name, platform=both, min_native_version?
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X POST 'https://api.aifoxapp.com/api/v1/apps/' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

GET/apps/{app_id}

Returns one app.

Full URL: https://api.aifoxapp.com/api/v1/apps/{app_id}
Access: JWT or API key
Inputs: app_id
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X GET 'https://api.aifoxapp.com/api/v1/apps/{app_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

PUT/apps/{app_id}

Updates an app.

Full URL: https://api.aifoxapp.com/api/v1/apps/{app_id}
Access: JWT or API key
Inputs: app_id; name?, min_native_version?, icon_url?
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X PUT 'https://api.aifoxapp.com/api/v1/apps/{app_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

DELETE/apps/{app_id}

Deletes an app.

Full URL: https://api.aifoxapp.com/api/v1/apps/{app_id}
Access: JWT or API key
Inputs: app_id
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X DELETE 'https://api.aifoxapp.com/api/v1/apps/{app_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

Bundles

GET/bundles/app/{app_id}

Lists active OTA bundles.

Full URL: https://api.aifoxapp.com/api/v1/bundles/app/{app_id}
Access: JWT or API key
Inputs: app_id
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X GET 'https://api.aifoxapp.com/api/v1/bundles/app/{app_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

POST/bundles/app/{app_id}/upload

Uploads and validates a bundle.

Full URL: https://api.aifoxapp.com/api/v1/bundles/app/{app_id}/upload
Access: JWT or API key
Inputs: multipart: version, file (.zip, max 200 MB)
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X POST 'https://api.aifoxapp.com/api/v1/bundles/app/{app_id}/upload' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -F 'version=1.0.0' -F 'file=@bundle.zip'

GET/bundles/{bundle_id}

Returns a bundle.

Full URL: https://api.aifoxapp.com/api/v1/bundles/{bundle_id}
Access: JWT or API key
Inputs: bundle_id
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X GET 'https://api.aifoxapp.com/api/v1/bundles/{bundle_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

DELETE/bundles/{bundle_id}

Marks a bundle removed.

Full URL: https://api.aifoxapp.com/api/v1/bundles/{bundle_id}
Access: JWT or API key
Inputs: bundle_id
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X DELETE 'https://api.aifoxapp.com/api/v1/bundles/{bundle_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

Channels

GET/channels/app/{app_id}

Lists distribution channels.

Full URL: https://api.aifoxapp.com/api/v1/channels/app/{app_id}
Access: JWT
Inputs: app_id
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X GET 'https://api.aifoxapp.com/api/v1/channels/app/{app_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

POST/channels/app/{app_id}

Creates a channel.

Full URL: https://api.aifoxapp.com/api/v1/channels/app/{app_id}
Access: JWT
Inputs: app_id; name, slug, public=false, ios=true, android=true
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X POST 'https://api.aifoxapp.com/api/v1/channels/app/{app_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

GET/channels/{channel_id}

Returns a channel.

Full URL: https://api.aifoxapp.com/api/v1/channels/{channel_id}
Access: JWT
Inputs: channel_id
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X GET 'https://api.aifoxapp.com/api/v1/channels/{channel_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

PUT/channels/{channel_id}

Updates a channel.

Full URL: https://api.aifoxapp.com/api/v1/channels/{channel_id}
Access: JWT
Inputs: channel_id; name?, current_bundle_id?, secondary_bundle_id?, public?, rollout_percentage? (0–100)
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X PUT 'https://api.aifoxapp.com/api/v1/channels/{channel_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

DELETE/channels/{channel_id}

Deletes a channel.

Full URL: https://api.aifoxapp.com/api/v1/channels/{channel_id}
Access: JWT
Inputs: channel_id
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X DELETE 'https://api.aifoxapp.com/api/v1/channels/{channel_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

POST/channels/{channel_id}/promote/{bundle_id}

Promotes a bundle and preserves the previous version.

Full URL: https://api.aifoxapp.com/api/v1/channels/{channel_id}/promote/{bundle_id}
Access: JWT
Inputs: channel_id, bundle_id
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X POST 'https://api.aifoxapp.com/api/v1/channels/{channel_id}/promote/{bundle_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

POST/channels/{channel_id}/rollback

Swaps current and previous bundles.

Full URL: https://api.aifoxapp.com/api/v1/channels/{channel_id}/rollback
Access: JWT
Inputs: channel_id
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X POST 'https://api.aifoxapp.com/api/v1/channels/{channel_id}/rollback' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

Devices

GET/devices/app/{app_id}

Lists devices.

Full URL: https://api.aifoxapp.com/api/v1/devices/app/{app_id}
Access: JWT
Inputs: app_id
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X GET 'https://api.aifoxapp.com/api/v1/devices/app/{app_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

POST/devices/app/{app_id}/register

Registers or refreshes a device.

Full URL: https://api.aifoxapp.com/api/v1/devices/app/{app_id}/register
Access: JWT
Inputs: app_id; device_id, platform=android, push_token?, push_provider?
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X POST 'https://api.aifoxapp.com/api/v1/devices/app/{app_id}/register' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

POST/devices/{device_id}/channel

Assigns a device to a channel.

Full URL: https://api.aifoxapp.com/api/v1/devices/{device_id}/channel
Access: JWT
Inputs: device_id, channel_id
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X POST 'https://api.aifoxapp.com/api/v1/devices/{device_id}/channel' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

Updates

POST/updates/check

Checks for an OTA update.

Full URL: https://api.aifoxapp.com/api/v1/updates/check
Access: App client
Inputs: device_id, app_id, version, platform, os_version?, plugin_version?, channel?, custom_id?
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X POST 'https://api.aifoxapp.com/api/v1/updates/check' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

POST/updates/downloaded

Records a downloaded bundle.

Full URL: https://api.aifoxapp.com/api/v1/updates/downloaded
Access: App client
Inputs: query: device_id, bundle_version, app_id
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X POST 'https://api.aifoxapp.com/api/v1/updates/downloaded' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

POST/updates/installed

Records an installed bundle.

Full URL: https://api.aifoxapp.com/api/v1/updates/installed
Access: App client
Inputs: query: device_id, bundle_version, app_id
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X POST 'https://api.aifoxapp.com/api/v1/updates/installed' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

POST/updates/failed

Records a failed update.

Full URL: https://api.aifoxapp.com/api/v1/updates/failed
Access: App client
Inputs: query: device_id, bundle_version, app_id, error?
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X POST 'https://api.aifoxapp.com/api/v1/updates/failed' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

GET/updates/bundle/{app_id}/{version}.zip

Downloads a signed, non-expired bundle.

Full URL: https://api.aifoxapp.com/api/v1/updates/bundle/{app_id}/{version}.zip
Access: Signed URL
Inputs: app_id, version; query: exp, sig
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X GET 'https://api.aifoxapp.com/api/v1/updates/bundle/{app_id}/{version}.zip' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

Manifests

GET/manifests/app/{app_id}

Lists immutable manifests.

Full URL: https://api.aifoxapp.com/api/v1/manifests/app/{app_id}
Access: JWT or API key
Inputs: app_id
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X GET 'https://api.aifoxapp.com/api/v1/manifests/app/{app_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

POST/manifests/app/{app_id}

Creates the next manifest version.

Full URL: https://api.aifoxapp.com/api/v1/manifests/app/{app_id}
Access: JWT or API key
Inputs: app_id; chassis=chassi1, data (requires app_name and primary_color)
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X POST 'https://api.aifoxapp.com/api/v1/manifests/app/{app_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

Modules

GET/module-runtime/registry/v2

Lists module schemas, phases, and plan requirements.

Full URL: https://api.aifoxapp.com/api/v1/module-runtime/registry/v2
Access: Public
Inputs: —
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X GET 'https://api.aifoxapp.com/api/v1/module-runtime/registry/v2' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

GET/module-runtime/public/{package_name}/config

Returns the sanitized published module configuration.

Full URL: https://api.aifoxapp.com/api/v1/module-runtime/public/{package_name}/config
Access: Public
Inputs: package_name
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X GET 'https://api.aifoxapp.com/api/v1/module-runtime/public/{package_name}/config' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

GET/module-runtime/custom-modules/v1

Lists declarative curated extensions with exact integrity hashes.

Full URL: https://api.aifoxapp.com/api/v1/module-runtime/custom-modules/v1
Access: Public
Inputs: —
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X GET 'https://api.aifoxapp.com/api/v1/module-runtime/custom-modules/v1' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

GET/module-runtime/app/{app_id}/config

Returns the administrative module configuration.

Full URL: https://api.aifoxapp.com/api/v1/module-runtime/app/{app_id}/config
Access: JWT
Inputs: app_id
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X GET 'https://api.aifoxapp.com/api/v1/module-runtime/app/{app_id}/config' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

PUT/module-runtime/app/{app_id}/config

Validates and updates the module configuration.

Full URL: https://api.aifoxapp.com/api/v1/module-runtime/app/{app_id}/config
Access: JWT
Inputs: app_id; modules[]
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X PUT 'https://api.aifoxapp.com/api/v1/module-runtime/app/{app_id}/config' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

POST/module-runtime/app/{app_id}/publish

Publishes the next manifest version.

Full URL: https://api.aifoxapp.com/api/v1/module-runtime/app/{app_id}/publish
Access: JWT
Inputs: app_id
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X POST 'https://api.aifoxapp.com/api/v1/module-runtime/app/{app_id}/publish' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

Content

GET/content/public/{package_name}/rss

Returns a validated and normalized RSS or Atom feed.

Full URL: https://api.aifoxapp.com/api/v1/content/public/{package_name}/rss
Access: Public
Inputs: package_name
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X GET 'https://api.aifoxapp.com/api/v1/content/public/{package_name}/rss' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

Commerce

GET/commerce/app/{app_id}/integrations

Returns sanitized connector status.

Full URL: https://api.aifoxapp.com/api/v1/commerce/app/{app_id}/integrations
Access: JWT
Inputs: app_id
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X GET 'https://api.aifoxapp.com/api/v1/commerce/app/{app_id}/integrations' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

POST/commerce/app/{app_id}/shopify/sync

Synchronizes a provisioned Shopify catalog.

Full URL: https://api.aifoxapp.com/api/v1/commerce/app/{app_id}/shopify/sync
Access: JWT
Inputs: app_id; limit?
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X POST 'https://api.aifoxapp.com/api/v1/commerce/app/{app_id}/shopify/sync' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

Purchases

POST/purchases/public/{package_name}/verify

Verifies a store purchase server-side for an authenticated app member.

Full URL: https://api.aifoxapp.com/api/v1/purchases/public/{package_name}/verify
Access: App client
Inputs: platform, product_id, product_type, purchase_token, environment?
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X POST 'https://api.aifoxapp.com/api/v1/purchases/public/{package_name}/verify' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

GET/purchases/public/{package_name}/entitlements

Lists the authenticated member's active entitlements.

Full URL: https://api.aifoxapp.com/api/v1/purchases/public/{package_name}/entitlements
Access: App client
Inputs: package_name
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X GET 'https://api.aifoxapp.com/api/v1/purchases/public/{package_name}/entitlements' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

Intelligence

POST/intelligence/public/{package_name}/assistant

Returns an answer grounded in the published app context.

Full URL: https://api.aifoxapp.com/api/v1/intelligence/public/{package_name}/assistant
Access: Public
Inputs: question
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X POST 'https://api.aifoxapp.com/api/v1/intelligence/public/{package_name}/assistant' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

POST/intelligence/app/{app_id}/autofill

Returns an administrative suggestion without applying it.

Full URL: https://api.aifoxapp.com/api/v1/intelligence/app/{app_id}/autofill
Access: JWT
Inputs: app_id; module_id
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X POST 'https://api.aifoxapp.com/api/v1/intelligence/app/{app_id}/autofill' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

Builds

GET/builds/app/{app_id}

Lists the latest 50 builds.

Full URL: https://api.aifoxapp.com/api/v1/builds/app/{app_id}
Access: JWT
Inputs: app_id
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X GET 'https://api.aifoxapp.com/api/v1/builds/app/{app_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

POST/builds/app/{app_id}/android

Queues an Android build.

Full URL: https://api.aifoxapp.com/api/v1/builds/app/{app_id}/android
Access: JWT or API key
Inputs: app_id
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X POST 'https://api.aifoxapp.com/api/v1/builds/app/{app_id}/android' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

POST/builds/app/{app_id}/ios

Queues an iOS build using configured provider.

Full URL: https://api.aifoxapp.com/api/v1/builds/app/{app_id}/ios
Access: JWT or API key
Inputs: app_id
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X POST 'https://api.aifoxapp.com/api/v1/builds/app/{app_id}/ios' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

GET/builds/{build_id}

Returns a build.

Full URL: https://api.aifoxapp.com/api/v1/builds/{build_id}
Access: JWT or API key
Inputs: build_id
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X GET 'https://api.aifoxapp.com/api/v1/builds/{build_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

Preview

POST/preview/generate

Generates a rate-limited preview session.

Full URL: https://api.aifoxapp.com/api/v1/preview/generate
Access: Public
Inputs: business? or site_url?
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X POST 'https://api.aifoxapp.com/api/v1/preview/generate' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

GET/preview/{session_id}

Returns an active preview session.

Full URL: https://api.aifoxapp.com/api/v1/preview/{session_id}
Access: Public
Inputs: session_id
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X GET 'https://api.aifoxapp.com/api/v1/preview/{session_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

Consultor

POST/consultor/chat

Sends a chat request to the public assistant.

Full URL: https://api.aifoxapp.com/api/v1/consultor/chat
Access: Public
Inputs: messages; business?
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X POST 'https://api.aifoxapp.com/api/v1/consultor/chat' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

Billing

GET/billing/plan

Returns plan and status.

Full URL: https://api.aifoxapp.com/api/v1/billing/plan
Access: JWT
Inputs: —
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X GET 'https://api.aifoxapp.com/api/v1/billing/plan' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

POST/billing/checkout

Creates a subscription Checkout session.

Full URL: https://api.aifoxapp.com/api/v1/billing/checkout
Access: JWT
Inputs: plan: essencial | profissional | loja | enterprise
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X POST 'https://api.aifoxapp.com/api/v1/billing/checkout' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

GET/billing/wallet

Returns balance and last 20 ledger items.

Full URL: https://api.aifoxapp.com/api/v1/billing/wallet
Access: JWT
Inputs: —
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X GET 'https://api.aifoxapp.com/api/v1/billing/wallet' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

POST/billing/topup

Creates a fixed-package credit top-up Checkout session.

Full URL: https://api.aifoxapp.com/api/v1/billing/topup
Access: JWT
Inputs: —
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X POST 'https://api.aifoxapp.com/api/v1/billing/topup' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

API keys

GET/api-keys/

Lists API keys.

Full URL: https://api.aifoxapp.com/api/v1/api-keys/
Access: JWT
Inputs: —
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X GET 'https://api.aifoxapp.com/api/v1/api-keys/' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

POST/api-keys/

Creates an API key; retain its raw value only when returned.

Full URL: https://api.aifoxapp.com/api/v1/api-keys/
Access: JWT
Inputs: name?
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X POST 'https://api.aifoxapp.com/api/v1/api-keys/' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

DELETE/api-keys/{key_id}

Revokes an API key.

Full URL: https://api.aifoxapp.com/api/v1/api-keys/{key_id}
Access: JWT
Inputs: key_id
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X DELETE 'https://api.aifoxapp.com/api/v1/api-keys/{key_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

Reseller

GET/reseller/children

Lists child organizations.

Full URL: https://api.aifoxapp.com/api/v1/reseller/children
Access: JWT
Inputs: —
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X GET 'https://api.aifoxapp.com/api/v1/reseller/children' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

POST/reseller/children

Creates a child organization.

Full URL: https://api.aifoxapp.com/api/v1/reseller/children
Access: JWT owner
Inputs: name, slug
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X POST 'https://api.aifoxapp.com/api/v1/reseller/children' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

PUT/reseller/branding

Updates reseller branding.

Full URL: https://api.aifoxapp.com/api/v1/reseller/branding
Access: JWT owner
Inputs: branding (object)
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X PUT 'https://api.aifoxapp.com/api/v1/reseller/branding' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

Notifications

POST/notifications/app/{app_id}/send

Sends push notifications to matching devices.

Full URL: https://api.aifoxapp.com/api/v1/notifications/app/{app_id}/send
Access: JWT
Inputs: app_id; title, body, channel_id?
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X POST 'https://api.aifoxapp.com/api/v1/notifications/app/{app_id}/send' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

Migration

POST/migration/importar_do_github

Imports a recognized CI configuration from GitHub.

Full URL: https://api.aifoxapp.com/api/v1/migration/importar_do_github
Access: JWT
Inputs: repo_url
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X POST 'https://api.aifoxapp.com/api/v1/migration/importar_do_github' \
  -H 'Authorization: Bearer $AIFOX_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

Stats

GET/stats/dashboard

Returns organization dashboard statistics.

Full URL: https://api.aifoxapp.com/api/v1/stats/dashboard
Access: JWT
Inputs: —
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X GET 'https://api.aifoxapp.com/api/v1/stats/dashboard' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

GET/stats/app/{app_id}

Returns app statistics.

Full URL: https://api.aifoxapp.com/api/v1/stats/app/{app_id}
Access: JWT
Inputs: app_id
Response: 200/201: operation result in JSON. The exact shape follows the resource returned by this handler.
Errors: Common errors: 401, 403, 404, 422, 429, and 503, depending on the operation.

curl -X GET 'https://api.aifoxapp.com/api/v1/stats/app/{app_id}' \
  -H 'Authorization: Bearer $AIFOX_TOKEN'

Not public: POST /builds/ci-callback e POST /billing/webhook are internal integrations and must not be called by customers.