AthausDoku

Retrieve a proposal

Aufruf, Parameter, Antwort und Fehler von GET /v1/proposals/{id}.

Zuletzt aktualisiert:

Returns one proposal of this API key with its current status. Poll it after a 202 until it leaves pending: approved means a person said yes and the message is queued, executed means it was delivered. Needs read access to inquiries.

Braucht den Scope read.

In der Konsole ausprobieren

Aufruf

GET https://api.athaus.ai/v1/proposals/{id}

Parameter

Pfad

NameTypPflichtBeschreibung
idstring (uuid)jaUUID of the proposal.

Kopf

NameTypPflichtBeschreibung
Athaus-VersionstringneinOptional and carries nothing a client needs: the version is the path. Accepted when it says v1 or 1. Any other value is a 400 api_version_unsupported.
If-None-MatchstringneinAn ETag you hold. If it is still current, the answer is 304 without a body.

Beispiel

curl "https://api.athaus.ai/v1/proposals/0190f3a2-7c1e-7b0e-9a41-5d2f6e8c3b17" \
  -H "Authorization: Bearer ath_live_..."

Antwort

Bei Erfolg kommt 200 mit Proposal.

Proposal

FeldTypBeschreibung
objectstringImmer proposal.
idstringUUID of the proposal.
statusstringEines von pending, approved, executed, failed, rejected, expired.
actionstringWhat the proposal does once it is approved. The list is open: new actions arrive, and a client treats an unknown one as a proposal it follows by status. Eines von inquiry.reply, inquiry.follow_up, listing.publish.
targetobjectWhat the action is about: an inquiry, or the listing (its listingId) to publish.
target.objectstringEines von inquiry, listing.
target.idstring
textstringThe message that goes to the person who inquired; for listing.publish a sentence naming the listing. Where a human changed a message before approving, the changed text.
livemodebooleanfalse for a proposal of the test office (test keys): approving it records the message as sent in the thread with a note that it was not delivered, and nothing leaves Athaus.
createdAtstring (date-time)
decidedAtstring (date-time) | nullWhen a human, an API key with the scope decide or the automation of the office said yes or no, or the proposal expired. Null while pending.
decidedByobject | nullThe API key that said yes or no. Null while pending and when a person or the office's automation decided.
decidedBy.objectstringImmer api_key.
decidedBy.idstring
decidedBy.namestring | null
executedAtstring (date-time) | nullWhen the message was delivered, or the listing went online. Null until then.

Köpfe der Antwort

KopfBeschreibung
Request-IdIdentifies this request. Quote it in a support request.
Athaus-VersionThe API version of this response: v1.
Athaus-ReleaseThe release of v1 that answered, for example 1.0. A label for support and changelogs; no request can select it.
ETagA strong entity tag of this state of the resource. Send it as If-Match to change or delete the resource only if it is unchanged, or as If-None-Match to read it only if it changed.
RateLimit-PolicyThe quota policy of the bucket that applies.
RateLimitRemaining quota and seconds until the bucket is full again.

Mit If-None-Match auf den aktuellen ETag antwortet die Operation 304 ohne Rumpf.

Fehler

Jeder Fehler kommt als Problem Details. Verzweige auf code, nicht auf title oder detail.

StatusCodesBedeutung
400invalid_id, api_version_unsupported, invalid_inputInvalid request.
401unauthorizedMissing or invalid API key.
403insufficient_permissions, plan_requiredThe key lacks a right, or the plan does not include API access.
404not_foundNothing under this ID.
429rate_limitedRate limit exceeded.
500internal_errorServer error.

Weiter lesen

Auf dieser Seite