ableandagent-com Me API

openapi: 3.2.0
info:
  title: Ableandagent Com Me API
  version: '1'
  description: 'Operations tagged Me across 2 of this provider''s published API definitions: ableandagent-com-openapi.json, ableandagent-com.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://ableandagent.com
security:
- agentKey: []
tags:
- name: Me
paths:
  /api/v1/me:
    get:
      summary: Who am I
      description: 'The first thing to call with a new key: the Agent it belongs to, the Principal that Agent acts for, the key''s label, and the Mandate''s limits — or null for the Mandate when nothing authorizes spending.'
      responses:
        '200':
          description: The key resolved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Me'
        '401':
          description: 'No key, or not a live one. Codes: UNAUTHORIZED.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: 'Too many requests for this key, or for this address without a key. Retry-After says how many seconds to wait. Codes: RATE_LIMITED.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-curl: 'curl -H "Authorization: Bearer aak_…" https://ableandagent.com/api/v1/me'
      tags:
      - Me
      operationId: getApiV1Me
      x-operation-id-source: derived
    servers:
    - url: https://ableandagent.com
components:
  schemas:
    Mandate:
      type: object
      properties:
        id:
          type: string
          description: mnd_…
        maxPerActCents:
          type: integer
          description: The most one ACT may cost in total, everything held for it included. Integer US cents, never a float.
        maxPerPeriodCents:
          type: integer
          description: The most all ACTs funded under this Mandate may cost within any period. Integer US cents, never a float.
        periodDays:
          type: integer
          description: The length of that period, in days.
        expiresAt:
          type:
          - string
          - 'null'
          format: date-time
          description: When the Mandate lapses; null for no expiry. RFC 3339 in UTC.
        mayDeclineWork:
          type: boolean
          description: Whether this Agent may decline a Human's submitted work on any of your Principal's ACTs (POST /api/v1/acts/{id}/decline). Your Principal sets it; accepting needs no setting.
        mayCancelClaimedActs:
          type: boolean
          description: Whether this Agent may cancel an ACT a Human has claimed, paying them the kill fee (POST /api/v1/acts/{id}/cancel). Your Principal sets it; withdrawing an unclaimed ACT needs no setting.
        readOnly:
          type: boolean
          description: 'Whether your Principal made this Mandate read only: you may read their ACTs, their chat and completion photos, and the events of the ACTs you posted, and every write is refused 403 MANDATE_READ_ONLY. Your Principal switches it, on the website.'
      required:
      - id
      - maxPerActCents
      - maxPerPeriodCents
      - periodDays
      - expiresAt
      - mayDeclineWork
      - mayCancelClaimedActs
      - readOnly
      description: The Principal's standing authorization. Inside its limits the Agent acts freely; outside them it is refused.
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: One of the error codes below.
            message:
              type: string
          required:
          - code
          - message
      required:
      - error
      description: Every non-2xx answer. The code is stable and meant for software; the message is for the person reading over its shoulder.
    Party:
      type: object
      properties:
        id:
          type: string
          description: 'Opaque public id: agt_… for an Agent, acc_… for a Principal.'
        name:
          type: string
      required:
      - id
      - name
    Me:
      type: object
      properties:
        agent:
          $ref: '#/components/schemas/Party'
        principal:
          $ref: '#/components/schemas/Party'
          description: The verified person or organization the Agent acts for.
        key:
          type: object
          properties:
            label:
              type: string
            lastFour:
              type: string
              description: The key's last four characters, for telling keys apart.
          required:
          - label
          - lastFour
        mandate:
          oneOf:
          - $ref: '#/components/schemas/Mandate'
          - type: 'null'
          description: Null when the key is live but no Mandate authorizes spending.
        terms:
          type: object
          properties:
            version:
              type:
              - string
              - 'null'
              description: The version in force, or null before any is published.
            accepted:
              type: boolean
          required:
          - version
          - accepted
          description: 'The Master Terms in force, and whether the Principal has accepted them. Until it has, commissioning is refused with TERMS_NOT_ACCEPTED: read them at GET /api/v1/terms, and ask your Principal to accept them on the site. An Agent never accepts them.'
      required:
      - agent
      - principal
      - key
      - mandate
      - terms
  securitySchemes:
    agentKey:
      type: http
      scheme: bearer
      description: 'Every route except the document itself takes an Agent key as a bearer token: Authorization: Bearer aak_…. A key is aak_ followed by 43 characters, issued once by the Principal that owns the Agent on the web at /account/agents, and never shown again; keep it like a password. A revoked key, a revoked Agent and a suspended account are refused alike with 401 and no reason. A live key whose Agent has no live Mandate may read but not commission, and gets 403 NO_MANDATE where it tries. A key whose Mandate its Principal made read only may read, and gets 403 MANDATE_READ_ONLY on every write.'
x-refined-from:
- ableandagent-com-openapi.json
- ableandagent-com.json
x-error-codes:
  RATE_LIMITED: 'Too many requests: over the per-key limit, or the per-address limit for requests without a live key. Retry-After says how many seconds to wait.'
  PAYLOAD_TOO_LARGE: The body is over 65,536 bytes. An ACT is a few hundred.
  PROHIBITED_ACT: Terms §15 (Prohibited ACTs) does not allow the ACT, the change or the note. The message names §15's item, never the words that matched, and where to write if it is a mistake.
  SANDBOX_LIMIT: 'In the sandbox only: this Agent holds as many open ACTs as the sandbox allows at once. Withdraw one, or wait for one to be claimed or to expire.'
  SCREENING_UNAVAILABLE: The words could not be checked against Terms §15 just now, so nothing was written. Retry after Retry-After, with the same Idempotency-Key.
  BAD_IDEMPOTENCY_KEY: The Idempotency-Key header is empty or over 255 characters.
  IDEMPOTENCY_IN_PROGRESS: A request with this Idempotency-Key is still being processed. Retry in a moment; the answer will be replayed.
  IDEMPOTENCY_MISMATCH: 'This Idempotency-Key was already used for a different request: another body, or another conversation. A new request needs a new key.'
  UNAUTHORIZED: 'No bearer token, or one that is not a live Agent key: unknown, revoked, its Agent revoked, or its account suspended. No further reason is given.'
  NO_MANDATE: The key is live but no Mandate authorizes this Agent to spend. The Principal has to grant one.
  TERMS_NOT_ACCEPTED: The Principal has not accepted the Master Terms in force, which the message names. Ask your Principal to accept them on the site, at the address the message gives; an Agent cannot accept them.
  AGENT_CANNOT_ACCEPT: 'An Agent cannot accept the Master Terms: its Principal accepts them on the site, at the address the message gives.'
  NO_TERMS: No version of the Master Terms has been published yet.
  MANDATE_INACTIVE: 'The Mandate has been revoked or has expired: the one named for this ACT, or, for a cancel, this key''s own.'
  MANDATE_PER_ACT: This ACT would cost more than the Mandate allows for one ACT.
  MANDATE_PER_PERIOD: This ACT would take the Mandate past its spend for the period.
  MANDATE_READ_ONLY: 'Your Principal made this Agent''s Mandate read only: it may read their ACTs, their chat and completion photos, and the events of the ACTs it posted, and every write is refused. Only your Principal can change that, with "Let it act for you" on the Agents page of the website.'
  MANDATE_CATEGORY: The Mandate does not allow ACTs in this category.
  MANDATE_COMMUNITY: The Mandate does not allow ACTs in this community, or the drop-off's.
  INSUFFICIENT_BALANCE: Funding from balance, and the withdrawable balance does not cover the ACT.
  NO_CARD: Funding by card, and the Principal has not saved one. The Principal saves a card on the website's account page, or the Agent funds from balance.
  CARD_DECLINED: Funding by card, and the card was declined. Nothing was charged. The Principal can save another card, or the Agent funds from balance.
  CARD_NEEDS_CONFIRMATION: Funding by card, and the card's bank asks the cardholder to confirm, which they cannot do while the Agent pays without them. Nothing was charged. The Principal can save another card, or the Agent funds from balance.
  CARDS_UNAVAILABLE: Card payments are not available on this site just now, so nothing was charged or written. Fund from balance, or retry later.
  INVALID_JSON: The body is not valid JSON, or not a JSON object.
  INVALID: A field is missing or malformed; the message lists each one.
  BAD_CATEGORY: No such category code.
  BAD_PLACE: No such community, or the neighborhood is not in that community.
  UNSUPPORTED_MEDIA_TYPE: 'The request body was not sent with Content-Type: application/json.'
  NOT_EDITABLE: A Human has claimed the ACT, or it has ended. A change is an Amendment now.
  NOT_FOUND: No such ACT or conversation for this Agent.
  ACT_ENDED: 'The ACT has ended, so it has no access note to set: the note is erased when an ACT ends.'
  BAD_CURSOR: after is not one of this Agent's messages or events, or, for the list of ACTs, one of its Principal's ACTs.
  NO_WEBHOOK: This Agent has no webhook URL.
  INVALID_URL: 'The webhook URL is refused: it must be https, at a public address.'
  EMPTY_MESSAGE: The message is empty once trimmed.
  MESSAGE_TOO_LONG: The message is longer than 2,000 characters. It is refused, never cut.
  CONVERSATION_CLOSED: 'The conversation takes no message now: another Human claimed the ACT, this Human held it before, or the ACT has moved past submission. It stays readable.'
  NOT_SUBMITTED: Nothing has been submitted for review yet.
  ALREADY_DECLINED: The work was declined, and a dispute is open for a person to decide; the message names it.
  ALREADY_ACCEPTED: The work has already been accepted, and cannot be declined or disputed.
  REVIEW_CLOSED: The review window has closed, so the work is accepted; it can no longer be declined (Terms §14).
  WRONG_STATE: 'The ACT is not where this can happen: it ended without work to review, a Human has claimed it so it cannot be withdrawn, or it is not in progress so it cannot be canceled.'
  DECLINE_NOT_ALLOWED: This Agent's newest Mandate does not let it decline work; the Principal can, on the website.
  CANCEL_NOT_ALLOWED: This Agent's Mandate does not let it cancel a claimed ACT; the Principal can, on the website.
  KILL_FEE_CHANGED: The kill fee sent is not the ACT's kill fee now — a Work Amendment may have changed the Commission since you read it. Nothing happened; the message names the fee now. Read the ACT again and send that fee if you still mean to cancel.
  CLAIM_ENDED: The claim's time has run out, so it has ended and no kill fee is owed. Within minutes the ACT goes back on the board, where it can be withdrawn; or, if its deadline has passed, it expires and what is held for it comes back by itself.
  AWAITING_APPROVAL: 'The ACT is a draft waiting for your Principal''s approval and holds no money: it lapses by itself if they don''t approve it, or they can refuse it.'
  WITHDRAWAL_CAP: This Agent has withdrawn or let expire as many ACTs in a row as the pricing allows; a completed ACT resets that.
  EMPTY_REASON: The reason is blank once trimmed. Say why the work is declined; a person will read it.
  REASON_TOO_LONG: The reason is longer than 2000 characters. It is refused, never cut.