API reference / ASO copy

Suggest competitors

POST/api/v1/aso/competitors/suggest

Authorization

Send your API key or MCP OAuth token in the Authorization: Bearer header. Active or trialing Unlimited is required.

Required permission content:write

Every mutation requires JSON and an Idempotency-Key. Reuse the same key and exact input when retrying.

Parameters

Idempotency-Keyheaderrequired

string

Persist this key for retries. Reusing it with changed input returns 409. Receipts are retained for at least 24 hours.

min length: 8 · max length: 128

projectIdqueryrequired

string · uuid

Project ID. generationId is accepted as an alias on project-scoped GET requests.

Request body

application/json

appNamebodyrequired

string

min length: 1 · max length: 200

appCategorybodyoptional

string

max length: 200 · default: ""

appDescriptionbodyoptional

string

max length: 5000

View complete request schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "appName": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "appCategory": {
      "default": "",
      "type": "string",
      "maxLength": 200
    },
    "appDescription": {
      "type": "string",
      "maxLength": 5000
    }
  },
  "required": [
    "appName"
  ],
  "additionalProperties": false
}

Request example

Set ALF_API_URL to https://dashboard.applaunchflow.com/api/v1 and ALF_API_KEY to your key. Replace sample IDs with your project’s values. Use a new ALF_REQUEST_ID for each new operation.

cURL

curl --request POST \
  --url "$ALF_API_URL/aso/competitors/suggest?projectId=11111111-1111-4111-8111-111111111111" \
  --header "Authorization: Bearer $ALF_API_KEY" \
  --header "Content-Type: application/json" \
  --header "Idempotency-Key: $ALF_REQUEST_ID" \
  --data '{
  "appName": "string"
}'

Response

Successful JSON responses wrap the result in data, with a request ID in meta.requestId.

searchTermsdatarequired

string[]

reasoningdatarequired

string

View response schema

{
  "type": "object",
  "required": [
    "data",
    "meta"
  ],
  "properties": {
    "data": {
      "$schema": "https://json-schema.org/draft/2020-12/schema",
      "type": "object",
      "properties": {
        "searchTerms": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "reasoning": {
          "type": "string"
        }
      },
      "required": [
        "searchTerms",
        "reasoning"
      ]
    },
    "meta": {
      "type": "object",
      "required": [
        "requestId"
      ],
      "properties": {
        "requestId": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

Errors & retries

Errors use application/problem+json. Check the stable code and keep requestId when contacting support. Respect Retry-After on 429 responses.

See error handling and idempotency →