> For the complete documentation index, see [llms.txt](https://docs.rvmpd.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.rvmpd.com/models.md).

# Models

## The Error object

```json
{"openapi":"3.1.0","info":{"title":"rvmpd API","version":"1.0.0"},"components":{"schemas":{"Error":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["invalid_request_error","authentication_error","permission_error","rate_limit_error","api_error"],"description":"A broad category of the error. Use code for specific handling."},"code":{"type":"string","enum":["invalid_request","unauthorized","forbidden","not_found","conflict","unprocessable","rate_limited","internal_error"],"description":"invalid_request: the request is malformed or a field is invalid. unauthorized: the credentials are missing or wrong. forbidden: the credentials are valid but cannot do this. not_found: the record does not exist, or belongs to another organization. conflict: the request clashes with existing data, such as a duplicate. unprocessable: the request is well formed but a value cannot be used, such as a phone number that is not real. rate_limited: too many requests. Wait and retry. internal_error: something went wrong on our side. Retry, and contact support with the request_id if it persists."},"message":{"type":"string","description":"A sentence for a person to read. Do not parse it; it may change."},"param":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The request field the error is about, such as channels[1].value. Null when the error is not about one field."},"request_id":{"type":"string","description":"Identifies this request. Include it when contacting support."},"duplicates":{"description":"Only on a 409 conflict from creating a contact or adding a channel. Lists the existing records that may be duplicates.","type":"object","properties":{"contacts":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","const":"contact"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The existing contact's id."},"name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The existing contact's job title."},"confidence":{"type":"string","enum":["exact","possible"],"description":"exact: the record shares an identifier, email, phone, LinkedIn profile or company domain with your request. possible: only the name is the same or similar."},"match":{"type":"object","properties":{"on":{"type":"string","enum":["identifier","email","phone","linkedin","domain","name"],"description":"What matched: an identifier such as a CRD, a channel, a company domain, or a name."},"value":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The value that matched, such as the email address or the identifier with its scheme. Null when the match is on a name."}},"required":["on","value"],"additionalProperties":false,"description":"Why this record was matched."},"companies":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"name":{"type":"string"},"relationship":{"type":"string","description":"What the contact is at this company, such as employee or owner."},"is_primary":{"type":"boolean","description":"True for the company the contact works at."}},"required":["id","name","relationship","is_primary"],"additionalProperties":false},"description":"The companies the existing contact is connected to, to help tell people apart."}},"required":["object","id","name","title","confidence","match","companies"],"additionalProperties":false,"description":"An existing contact that may be the same person."},"description":"Existing contacts that may be the same person. Exact matches come first."},"companies":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","const":"company"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","description":"The existing company's id. To connect a contact to it, send it as company.id."},"name":{"type":"string"},"domain":{"anyOf":[{"type":"string"},{"type":"null"}]},"confidence":{"type":"string","enum":["exact","possible"],"description":"exact: the record shares an identifier, email, phone, LinkedIn profile or company domain with your request. possible: only the name is the same or similar."},"match":{"type":"object","properties":{"on":{"type":"string","enum":["identifier","email","phone","linkedin","domain","name"],"description":"What matched: an identifier such as a CRD, a channel, a company domain, or a name."},"value":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The value that matched, such as the email address or the identifier with its scheme. Null when the match is on a name."}},"required":["on","value"],"additionalProperties":false,"description":"Why this record was matched."}},"required":["object","id","name","domain","confidence","match"],"additionalProperties":false,"description":"An existing company that may be the same company."},"description":"Existing companies that may be the same company. Only present when the request would create a company."}},"required":["contacts","companies"],"additionalProperties":false}},"required":["type","code","message","param","request_id"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"description":"Every error response has this shape."}}}}
```
