Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Arvx Ai Records API
version: 1.0.0
contact:
email: help@arvx.ai
url: https://developer.arvx.ai/docs
termsOfService: https://developer.arvx.ai/terms
description: 'Operations tagged Records across 2 of this provider''s published API definitions: developer.arvx.ai-openapi.json, arvx-ai-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.arvx.ai
description: ARVX for Developers
security:
- key: []
- bearer: []
tags:
- name: Records
paths:
/v1/records/summary:
post:
operationId: recordSummary
summary: What is held about someone
description: 'When someone asks what is held about them: returns every item in the record in plain words. Never uses up a Reading. 10 a month per account.'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- record
- user
- other
- reason
properties:
record:
type: string
user:
type: object
required:
- email
properties:
email:
type: string
format: email
other:
type: object
required:
- email
properties:
email:
type: string
format: email
reason:
type: string
enum:
- access_request
- correction
- deletion_check
responses:
'200':
description: Every item in the record, in plain words.
content:
application/json:
schema:
type: object
'400':
description: A field is missing or wrong. error names the field.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: No key, or a key we don't recognize.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: 'The account needs a current statement of intended use, or the key is switched off. error says what to do. Reasons: statement_required, revoked, suspended, inactive.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
description: 'Too fast (over 30 a minute from one key; wait the seconds in Retry-After) or the account''s daily limit of 1,000 (days end at midnight Eastern time). Reasons: too_fast, daily_limit.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
headers:
Retry-After:
schema:
type: integer
'503':
description: 'Readings are paused for now. Try again later. Reasons: paused.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- Records
servers:
- url: https://api.arvx.ai
description: ARVX for Developers
components:
schemas:
Error:
type: object
required:
- error
properties:
error:
type: string
description: A sentence you can show.
reason:
type: string
securitySchemes:
key:
type: apiKey
in: header
name: x-arvx-key
bearer:
type: http
scheme: bearer
externalDocs:
url: https://developer.arvx.ai/docs
x-refined-from:
- developer.arvx.ai-openapi.json
- arvx-ai-openapi.json