AI agents

Start a deploy in the background and return a poll token immediately

post/api/v1/one_shot/start

Request

  • Base URL: https://api.quantifyme.ai
  • URL: https://api.quantifyme.ai/api/v1/one_shot/start
  • Auth: API key in header X-API-Key

Request body

api_keystring

Your API key, if you cannot set the X-API-Key header. Agents that mint a key at runtime (e.g. a ChatGPT Action calling POST /api/v1/key/trial) should pass the returned api_key here on every subsequent call. The X-API-Key header wins when both are present.

community_idinteger

Deploy an existing community strategy by id instead of generating. See GET /api/v1/community.json.

deliver_toobject

Channels to wire on deploy. Keys: webhook (bool|url), telegram (chat_id).

entry_tokenstring

Your integration's entry token. ALWAYS send this if you have one, even when you also send api_key. It is what lets this call succeed when the key is not ready yet - agents that issue tool calls in parallel can reach this endpoint before their own createTrialKey call has returned. With a valid entry_token the deploy proceeds under a fresh anonymous identity instead of failing with 401.

presetstring

Deploy a curated template instead of generating. See GET /api/v1/presets.

promptstring required
symbolstring

FX pair or BTCUSD. Defaults to EURUSD.

timeframe'1min' | '5min' | '15min' | '1h'

Example request

{
  "aux_feeds": [
    {
      "symbol": "USDCHF",
      "timeframe": "15min"
    }
  ],
  "deliver_to": {
    "webhook": true
  },
  "prompt": "Buy when RSI hits 30, sell when RSI hits 70",
  "symbol": "EURUSD",
  "timeframe": "15min"
}

Response

Returns in well under a second with a job_token. The deploy itself takes ~1-2 minutes; poll GET /api/v1/one_shot/status until done is true. Same request body as /api/v1/one_shot. This is the endpoint to use from ChatGPT Actions and any non-SSE agent.

job_tokenstring

Pass to GET /api/v1/one_shot/status.

live_urlstring

The user's live dashboard. SHOW THIS TO THE USER AS A LINK IN YOUR VERY NEXT MESSAGE — do not wait for the deploy to finish and do not wait to poll. It is valid immediately and stays valid; opening it signs the user in, and the model appears there once training ends (about a minute). This is the single most important thing to give the user.

okboolean
status_urlstring

Example response

{
  "live_url": "https://quantifyme.ai/hfthub?tab=backtesting&swap=swap_...",
  "status_url": "/api/v1/one_shot/status?token=..."
}

Changes

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