alpha

Run advisor reviews

Run Advisor now: a free review of the organization's whole list. admitted starts one, whose runId platform_runs_get_v2 follows; owed means a review is running (its runId), so one more runs right after it; refused carries Billing's reason. When the newest review failed this is Run again, and the new review names the one it runs again. A repeated Idempotency-Key answers the review its first request admitted.

post/api/v1/alpha/advisor-reviews/run

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/alpha/advisor-reviews/run
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://auth.point11.ai/oauth2/authorize, token URL https://auth.point11.ai/oauth2/token)

Headers

Point11-Organizationstring uuid

Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.

Idempotency-Keystring uuid required

UUID naming this intent. Retry with the same key; reuse for other input is 409.

Request body

AlphaAdvisorReviewsRunRequest required

Response

Success.

state'admitted' | 'owed' | 'refused' required

admitted: a review started. owed: one is running, and one more runs right after it. refused: it could not start now

runIdstring uuid nullable required

The review admitted, or the one running when owed; null when refused (or when the running one could not be read)

reasonstring nullable required

Why it could not start, when refused (Billing's admission refusal)

messagestring nullable required

The sentence Billing words a refusal in, with the one action that changes it; null unless refused for the account's billing standing

Changes

No recorded changes to this operation across all 1 revision of this API.