Opportunities
Available from Phase 4b
/api/v1/apps/{id}/opportunitiesAn app token (sk_live_, sk_test_, pk_live_), a browser token (a 5-minute ES256 JWT) or an agent token (sa_live_).
In: header
Path Parameters
uuidQuery Parameters
1 <= value <= 200501 <= lengthResponse Body
application/json
application/json
curl -X GET "https://example.com/api/v1/apps/497f6eca-6276-4993-bfeb-53cbbbba6f08/opportunities"{ "data": [ { "appId": "28c365d5-df94-4a54-8217-3ce51d068868", "source": "agent", "location": { "file": "string", "lines": "string" }, "currentApproach": "regex", "decisionSummary": "string", "primitiveGuess": "noul", "pattern": "fan_out", "tenSecondFit": true, "status": "proposed", "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "orgId": "25b2c2d5-a7fc-47d0-89e4-8709a1560bfa", "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620", "createdByTokenId": "88c1c6d9-c65c-4d23-8d53-4eb1f94d25ce", "createdAt": "2019-08-24T14:15:22Z" } ], "nextCursor": "string"}/api/v1/apps/{id}/opportunitiesAn app token (sk_live_, sk_test_, pk_live_), a browser token (a 5-minute ES256 JWT) or an agent token (sa_live_).
In: header
Path Parameters
uuidHeader Parameters
Required for app and agent tokens on mutations. A replay within 24 hours returns the stored response.
1 <= lengthRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/api/v1/apps/497f6eca-6276-4993-bfeb-53cbbbba6f08/opportunities" \ -H "Content-Type: application/json" \ -d '{ "appId": "28c365d5-df94-4a54-8217-3ce51d068868", "source": "agent", "location": { "file": "string", "lines": "string" }, "currentApproach": "regex", "decisionSummary": "string", "primitiveGuess": "noul", "pattern": "fan_out", "tenSecondFit": true, "status": "proposed", "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3" }'{ "appId": "28c365d5-df94-4a54-8217-3ce51d068868", "source": "agent", "location": { "file": "string", "lines": "string" }, "currentApproach": "regex", "decisionSummary": "string", "primitiveGuess": "noul", "pattern": "fan_out", "tenSecondFit": true, "status": "proposed", "setId": "83e19bc1-5428-42b5-88ea-b28354e481f3", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "orgId": "25b2c2d5-a7fc-47d0-89e4-8709a1560bfa", "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620", "createdByTokenId": "88c1c6d9-c65c-4d23-8d53-4eb1f94d25ce", "createdAt": "2019-08-24T14:15:22Z"}/api/v1/apps/{id}/opportunities/{oid}An app token (sk_live_, sk_test_, pk_live_), a browser token (a 5-minute ES256 JWT) or an agent token (sa_live_).
In: header
Path Parameters
uuiduuidHeader Parameters
Required for app and agent tokens on mutations. A replay within 24 hours returns the stored response.
1 <= lengthRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X PATCH "https://example.com/api/v1/apps/497f6eca-6276-4993-bfeb-53cbbbba6f08/opportunities/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{ "property1": null, "property2": null }'nullBandwise is an independent product built on TypeSafe's System One models. It is not TypeSafe's documentation. For the System One models themselves, see docs.typesafe.ai.