@opusdns/api 0.282.0 → 0.284.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +33 -0
- package/package.json +3 -2
- package/src/helpers/constants.ts +163 -1
- package/src/helpers/keys.ts +10189 -8422
- package/src/helpers/requests.d.ts +682 -4
- package/src/helpers/responses.d.ts +1652 -5
- package/src/helpers/schemas-arrays.d.ts +57 -1
- package/src/helpers/schemas.d.ts +272 -0
- package/src/openapi.yaml +1636 -22
- package/src/schema.d.ts +1666 -14
package/src/openapi.yaml
CHANGED
|
@@ -1585,6 +1585,190 @@ components:
|
|
|
1585
1585
|
title: Update Supported Roles
|
|
1586
1586
|
title: ContactsBase
|
|
1587
1587
|
type: object
|
|
1588
|
+
Context:
|
|
1589
|
+
properties:
|
|
1590
|
+
context_id:
|
|
1591
|
+
examples:
|
|
1592
|
+
- ctx_01h45ytscbebyvny4gc8cr8ma2
|
|
1593
|
+
format: typeid
|
|
1594
|
+
pattern: ^ctx_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
1595
|
+
title: Context Id
|
|
1596
|
+
type: string
|
|
1597
|
+
x-typeid-prefix: ctx
|
|
1598
|
+
conversation_id:
|
|
1599
|
+
examples:
|
|
1600
|
+
- conv_01h45ytscbebyvny4gc8cr8ma2
|
|
1601
|
+
format: typeid
|
|
1602
|
+
pattern: ^conv_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
1603
|
+
title: Conversation Id
|
|
1604
|
+
type: string
|
|
1605
|
+
x-typeid-prefix: conv
|
|
1606
|
+
created_at:
|
|
1607
|
+
format: date-time
|
|
1608
|
+
title: Created At
|
|
1609
|
+
type: string
|
|
1610
|
+
kind:
|
|
1611
|
+
$ref: '#/components/schemas/MessageContextKind'
|
|
1612
|
+
organization_id:
|
|
1613
|
+
examples:
|
|
1614
|
+
- organization_01h45ytscbebyvny4gc8cr8ma2
|
|
1615
|
+
format: typeid
|
|
1616
|
+
pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
1617
|
+
title: Organization Id
|
|
1618
|
+
type: string
|
|
1619
|
+
x-typeid-prefix: organization
|
|
1620
|
+
payload:
|
|
1621
|
+
additionalProperties: true
|
|
1622
|
+
title: Payload
|
|
1623
|
+
type: object
|
|
1624
|
+
user_id:
|
|
1625
|
+
title: User Id
|
|
1626
|
+
type: string
|
|
1627
|
+
required:
|
|
1628
|
+
- context_id
|
|
1629
|
+
- conversation_id
|
|
1630
|
+
- organization_id
|
|
1631
|
+
- user_id
|
|
1632
|
+
- kind
|
|
1633
|
+
- created_at
|
|
1634
|
+
title: Context
|
|
1635
|
+
type: object
|
|
1636
|
+
ContextCreateRequest:
|
|
1637
|
+
properties:
|
|
1638
|
+
kind:
|
|
1639
|
+
$ref: '#/components/schemas/MessageContextKind'
|
|
1640
|
+
payload:
|
|
1641
|
+
additionalProperties: true
|
|
1642
|
+
description: Non-empty structured payload. Shape depends on `kind`.
|
|
1643
|
+
minProperties: 1
|
|
1644
|
+
title: Payload
|
|
1645
|
+
type: object
|
|
1646
|
+
required:
|
|
1647
|
+
- kind
|
|
1648
|
+
- payload
|
|
1649
|
+
title: ContextCreateRequest
|
|
1650
|
+
type: object
|
|
1651
|
+
ContextListResponse:
|
|
1652
|
+
properties:
|
|
1653
|
+
pagination:
|
|
1654
|
+
$ref: '#/components/schemas/PaginationMetadata'
|
|
1655
|
+
results:
|
|
1656
|
+
items:
|
|
1657
|
+
$ref: '#/components/schemas/Context'
|
|
1658
|
+
title: Results
|
|
1659
|
+
type: array
|
|
1660
|
+
required:
|
|
1661
|
+
- results
|
|
1662
|
+
- pagination
|
|
1663
|
+
title: ContextListResponse
|
|
1664
|
+
type: object
|
|
1665
|
+
Conversation:
|
|
1666
|
+
properties:
|
|
1667
|
+
conversation_id:
|
|
1668
|
+
examples:
|
|
1669
|
+
- conv_01h45ytscbebyvny4gc8cr8ma2
|
|
1670
|
+
format: typeid
|
|
1671
|
+
pattern: ^conv_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
1672
|
+
title: Conversation Id
|
|
1673
|
+
type: string
|
|
1674
|
+
x-typeid-prefix: conv
|
|
1675
|
+
created_at:
|
|
1676
|
+
format: date-time
|
|
1677
|
+
title: Created At
|
|
1678
|
+
type: string
|
|
1679
|
+
last_message_at:
|
|
1680
|
+
anyOf:
|
|
1681
|
+
- format: date-time
|
|
1682
|
+
type: string
|
|
1683
|
+
- type: 'null'
|
|
1684
|
+
title: Last Message At
|
|
1685
|
+
message_count:
|
|
1686
|
+
default: 0
|
|
1687
|
+
title: Message Count
|
|
1688
|
+
type: integer
|
|
1689
|
+
metadata:
|
|
1690
|
+
additionalProperties: true
|
|
1691
|
+
title: Metadata
|
|
1692
|
+
type: object
|
|
1693
|
+
organization_id:
|
|
1694
|
+
examples:
|
|
1695
|
+
- organization_01h45ytscbebyvny4gc8cr8ma2
|
|
1696
|
+
format: typeid
|
|
1697
|
+
pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
1698
|
+
title: Organization Id
|
|
1699
|
+
type: string
|
|
1700
|
+
x-typeid-prefix: organization
|
|
1701
|
+
summary:
|
|
1702
|
+
anyOf:
|
|
1703
|
+
- type: string
|
|
1704
|
+
- type: 'null'
|
|
1705
|
+
description: Optional rolling summary maintained by the memory service.
|
|
1706
|
+
title: Summary
|
|
1707
|
+
title:
|
|
1708
|
+
anyOf:
|
|
1709
|
+
- type: string
|
|
1710
|
+
- type: 'null'
|
|
1711
|
+
description: Human-readable conversation title.
|
|
1712
|
+
title: Title
|
|
1713
|
+
updated_at:
|
|
1714
|
+
format: date-time
|
|
1715
|
+
title: Updated At
|
|
1716
|
+
type: string
|
|
1717
|
+
user_id:
|
|
1718
|
+
title: User Id
|
|
1719
|
+
type: string
|
|
1720
|
+
required:
|
|
1721
|
+
- conversation_id
|
|
1722
|
+
- organization_id
|
|
1723
|
+
- user_id
|
|
1724
|
+
- created_at
|
|
1725
|
+
- updated_at
|
|
1726
|
+
title: Conversation
|
|
1727
|
+
type: object
|
|
1728
|
+
ConversationCreateRequest:
|
|
1729
|
+
properties:
|
|
1730
|
+
metadata:
|
|
1731
|
+
additionalProperties: true
|
|
1732
|
+
title: Metadata
|
|
1733
|
+
type: object
|
|
1734
|
+
title:
|
|
1735
|
+
anyOf:
|
|
1736
|
+
- maxLength: 200
|
|
1737
|
+
type: string
|
|
1738
|
+
- type: 'null'
|
|
1739
|
+
title: Title
|
|
1740
|
+
title: ConversationCreateRequest
|
|
1741
|
+
type: object
|
|
1742
|
+
ConversationListResponse:
|
|
1743
|
+
properties:
|
|
1744
|
+
pagination:
|
|
1745
|
+
$ref: '#/components/schemas/PaginationMetadata'
|
|
1746
|
+
results:
|
|
1747
|
+
items:
|
|
1748
|
+
$ref: '#/components/schemas/Conversation'
|
|
1749
|
+
title: Results
|
|
1750
|
+
type: array
|
|
1751
|
+
required:
|
|
1752
|
+
- results
|
|
1753
|
+
- pagination
|
|
1754
|
+
title: ConversationListResponse
|
|
1755
|
+
type: object
|
|
1756
|
+
ConversationPatchRequest:
|
|
1757
|
+
properties:
|
|
1758
|
+
metadata:
|
|
1759
|
+
anyOf:
|
|
1760
|
+
- additionalProperties: true
|
|
1761
|
+
type: object
|
|
1762
|
+
- type: 'null'
|
|
1763
|
+
title: Metadata
|
|
1764
|
+
title:
|
|
1765
|
+
anyOf:
|
|
1766
|
+
- maxLength: 200
|
|
1767
|
+
type: string
|
|
1768
|
+
- type: 'null'
|
|
1769
|
+
title: Title
|
|
1770
|
+
title: ConversationPatchRequest
|
|
1771
|
+
type: object
|
|
1588
1772
|
CreateJobBatchResponse:
|
|
1589
1773
|
properties:
|
|
1590
1774
|
batch_id:
|
|
@@ -6404,6 +6588,215 @@ components:
|
|
|
6404
6588
|
- business_entity
|
|
6405
6589
|
title: LocalPresenceRequirementType
|
|
6406
6590
|
type: string
|
|
6591
|
+
MemoryFact:
|
|
6592
|
+
properties:
|
|
6593
|
+
created_at:
|
|
6594
|
+
format: date-time
|
|
6595
|
+
title: Created At
|
|
6596
|
+
type: string
|
|
6597
|
+
expires_at:
|
|
6598
|
+
anyOf:
|
|
6599
|
+
- format: date-time
|
|
6600
|
+
type: string
|
|
6601
|
+
- type: 'null'
|
|
6602
|
+
title: Expires At
|
|
6603
|
+
fact_id:
|
|
6604
|
+
examples:
|
|
6605
|
+
- fact_01h45ytscbebyvny4gc8cr8ma2
|
|
6606
|
+
format: typeid
|
|
6607
|
+
pattern: ^fact_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
6608
|
+
title: Fact Id
|
|
6609
|
+
type: string
|
|
6610
|
+
x-typeid-prefix: fact
|
|
6611
|
+
key:
|
|
6612
|
+
maxLength: 200
|
|
6613
|
+
title: Key
|
|
6614
|
+
type: string
|
|
6615
|
+
kind:
|
|
6616
|
+
$ref: '#/components/schemas/MemoryFactKind'
|
|
6617
|
+
organization_id:
|
|
6618
|
+
examples:
|
|
6619
|
+
- organization_01h45ytscbebyvny4gc8cr8ma2
|
|
6620
|
+
format: typeid
|
|
6621
|
+
pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
6622
|
+
title: Organization Id
|
|
6623
|
+
type: string
|
|
6624
|
+
x-typeid-prefix: organization
|
|
6625
|
+
updated_at:
|
|
6626
|
+
format: date-time
|
|
6627
|
+
title: Updated At
|
|
6628
|
+
type: string
|
|
6629
|
+
value:
|
|
6630
|
+
additionalProperties: true
|
|
6631
|
+
title: Value
|
|
6632
|
+
type: object
|
|
6633
|
+
required:
|
|
6634
|
+
- fact_id
|
|
6635
|
+
- organization_id
|
|
6636
|
+
- kind
|
|
6637
|
+
- key
|
|
6638
|
+
- created_at
|
|
6639
|
+
- updated_at
|
|
6640
|
+
title: MemoryFact
|
|
6641
|
+
type: object
|
|
6642
|
+
MemoryFactCreateRequest:
|
|
6643
|
+
properties:
|
|
6644
|
+
key:
|
|
6645
|
+
maxLength: 200
|
|
6646
|
+
minLength: 1
|
|
6647
|
+
title: Key
|
|
6648
|
+
type: string
|
|
6649
|
+
kind:
|
|
6650
|
+
$ref: '#/components/schemas/MemoryFactKind'
|
|
6651
|
+
ttl_seconds:
|
|
6652
|
+
anyOf:
|
|
6653
|
+
- minimum: 1.0
|
|
6654
|
+
type: integer
|
|
6655
|
+
- type: 'null'
|
|
6656
|
+
description: Optional TTL; if set, the fact expires after this many seconds.
|
|
6657
|
+
title: Ttl Seconds
|
|
6658
|
+
value:
|
|
6659
|
+
additionalProperties: true
|
|
6660
|
+
title: Value
|
|
6661
|
+
type: object
|
|
6662
|
+
required:
|
|
6663
|
+
- kind
|
|
6664
|
+
- key
|
|
6665
|
+
title: MemoryFactCreateRequest
|
|
6666
|
+
type: object
|
|
6667
|
+
MemoryFactKind:
|
|
6668
|
+
enum:
|
|
6669
|
+
- preference
|
|
6670
|
+
- note
|
|
6671
|
+
- other
|
|
6672
|
+
title: MemoryFactKind
|
|
6673
|
+
type: string
|
|
6674
|
+
MemoryFactListResponse:
|
|
6675
|
+
properties:
|
|
6676
|
+
next_cursor:
|
|
6677
|
+
anyOf:
|
|
6678
|
+
- type: string
|
|
6679
|
+
- type: 'null'
|
|
6680
|
+
title: Next Cursor
|
|
6681
|
+
results:
|
|
6682
|
+
items:
|
|
6683
|
+
$ref: '#/components/schemas/MemoryFact'
|
|
6684
|
+
title: Results
|
|
6685
|
+
type: array
|
|
6686
|
+
required:
|
|
6687
|
+
- results
|
|
6688
|
+
title: MemoryFactListResponse
|
|
6689
|
+
type: object
|
|
6690
|
+
MemoryFactPatchRequest:
|
|
6691
|
+
properties:
|
|
6692
|
+
ttl_seconds:
|
|
6693
|
+
anyOf:
|
|
6694
|
+
- minimum: 1.0
|
|
6695
|
+
type: integer
|
|
6696
|
+
- type: 'null'
|
|
6697
|
+
title: Ttl Seconds
|
|
6698
|
+
value:
|
|
6699
|
+
anyOf:
|
|
6700
|
+
- additionalProperties: true
|
|
6701
|
+
type: object
|
|
6702
|
+
- type: 'null'
|
|
6703
|
+
title: Value
|
|
6704
|
+
title: MemoryFactPatchRequest
|
|
6705
|
+
type: object
|
|
6706
|
+
Message:
|
|
6707
|
+
properties:
|
|
6708
|
+
content:
|
|
6709
|
+
title: Content
|
|
6710
|
+
type: string
|
|
6711
|
+
conversation_id:
|
|
6712
|
+
examples:
|
|
6713
|
+
- conv_01h45ytscbebyvny4gc8cr8ma2
|
|
6714
|
+
format: typeid
|
|
6715
|
+
pattern: ^conv_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
6716
|
+
title: Conversation Id
|
|
6717
|
+
type: string
|
|
6718
|
+
x-typeid-prefix: conv
|
|
6719
|
+
created_at:
|
|
6720
|
+
format: date-time
|
|
6721
|
+
title: Created At
|
|
6722
|
+
type: string
|
|
6723
|
+
message_id:
|
|
6724
|
+
examples:
|
|
6725
|
+
- msg_01h45ytscbebyvny4gc8cr8ma2
|
|
6726
|
+
format: typeid
|
|
6727
|
+
pattern: ^msg_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
6728
|
+
title: Message Id
|
|
6729
|
+
type: string
|
|
6730
|
+
x-typeid-prefix: msg
|
|
6731
|
+
metadata:
|
|
6732
|
+
additionalProperties: true
|
|
6733
|
+
title: Metadata
|
|
6734
|
+
type: object
|
|
6735
|
+
role:
|
|
6736
|
+
$ref: '#/components/schemas/MessageRole'
|
|
6737
|
+
required:
|
|
6738
|
+
- message_id
|
|
6739
|
+
- conversation_id
|
|
6740
|
+
- role
|
|
6741
|
+
- content
|
|
6742
|
+
- created_at
|
|
6743
|
+
title: Message
|
|
6744
|
+
type: object
|
|
6745
|
+
MessageContextKind:
|
|
6746
|
+
enum:
|
|
6747
|
+
- zones
|
|
6748
|
+
- contacts
|
|
6749
|
+
- domains
|
|
6750
|
+
- batch_ids
|
|
6751
|
+
- other
|
|
6752
|
+
title: MessageContextKind
|
|
6753
|
+
type: string
|
|
6754
|
+
MessageCreateRequest:
|
|
6755
|
+
properties:
|
|
6756
|
+
content:
|
|
6757
|
+
title: Content
|
|
6758
|
+
type: string
|
|
6759
|
+
metadata:
|
|
6760
|
+
additionalProperties: true
|
|
6761
|
+
title: Metadata
|
|
6762
|
+
type: object
|
|
6763
|
+
n8n_history_id:
|
|
6764
|
+
anyOf:
|
|
6765
|
+
- type: integer
|
|
6766
|
+
- type: 'null'
|
|
6767
|
+
description: Optional reference to the originating n8n_chat_histories row.
|
|
6768
|
+
title: N8N History Id
|
|
6769
|
+
role:
|
|
6770
|
+
$ref: '#/components/schemas/MessageRole'
|
|
6771
|
+
required:
|
|
6772
|
+
- role
|
|
6773
|
+
- content
|
|
6774
|
+
title: MessageCreateRequest
|
|
6775
|
+
type: object
|
|
6776
|
+
MessageListResponse:
|
|
6777
|
+
properties:
|
|
6778
|
+
pagination:
|
|
6779
|
+
anyOf:
|
|
6780
|
+
- $ref: '#/components/schemas/PaginationMetadata'
|
|
6781
|
+
- type: 'null'
|
|
6782
|
+
description: Omitted when the `recent` query parameter is used.
|
|
6783
|
+
results:
|
|
6784
|
+
items:
|
|
6785
|
+
$ref: '#/components/schemas/Message'
|
|
6786
|
+
title: Results
|
|
6787
|
+
type: array
|
|
6788
|
+
required:
|
|
6789
|
+
- results
|
|
6790
|
+
title: MessageListResponse
|
|
6791
|
+
type: object
|
|
6792
|
+
MessageRole:
|
|
6793
|
+
enum:
|
|
6794
|
+
- user
|
|
6795
|
+
- assistant
|
|
6796
|
+
- system
|
|
6797
|
+
- tool
|
|
6798
|
+
title: MessageRole
|
|
6799
|
+
type: string
|
|
6407
6800
|
MetricsGrouping:
|
|
6408
6801
|
enum:
|
|
6409
6802
|
- url
|
|
@@ -8311,15 +8704,21 @@ components:
|
|
|
8311
8704
|
PremiumPricingAction:
|
|
8312
8705
|
properties:
|
|
8313
8706
|
action:
|
|
8314
|
-
description: The action (e.g., create, renew, transfer)
|
|
8707
|
+
description: The action this price applies to (e.g., create, renew, transfer)
|
|
8708
|
+
examples:
|
|
8709
|
+
- create
|
|
8315
8710
|
title: Action
|
|
8316
8711
|
type: string
|
|
8317
8712
|
currency:
|
|
8318
|
-
description:
|
|
8713
|
+
description: ISO 4217 currency code
|
|
8714
|
+
examples:
|
|
8715
|
+
- EUR
|
|
8319
8716
|
title: Currency
|
|
8320
8717
|
type: string
|
|
8321
8718
|
price:
|
|
8322
|
-
description:
|
|
8719
|
+
description: Price for the action
|
|
8720
|
+
examples:
|
|
8721
|
+
- '625.00'
|
|
8323
8722
|
pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
|
|
8324
8723
|
title: Price
|
|
8325
8724
|
type: string
|
|
@@ -10173,35 +10572,47 @@ components:
|
|
|
10173
10572
|
common__models__domain__domain__DomainAvailabilityResponse:
|
|
10174
10573
|
properties:
|
|
10175
10574
|
available:
|
|
10575
|
+
description: True if the domain is available for registration
|
|
10176
10576
|
title: Available
|
|
10177
10577
|
type: boolean
|
|
10178
10578
|
claims_key:
|
|
10179
10579
|
anyOf:
|
|
10180
10580
|
- type: string
|
|
10181
10581
|
- type: 'null'
|
|
10182
|
-
description:
|
|
10582
|
+
description: Trademark claims key returned when the TLD is in its claims
|
|
10583
|
+
phase and the domain matches a TMCH-registered mark. When present, the
|
|
10584
|
+
corresponding claims notice must be retrieved and acknowledged before
|
|
10585
|
+
registration.
|
|
10586
|
+
examples:
|
|
10587
|
+
- 2013041500/2/6/9/rJ1NrDO92vDsAzf7EQzgjX4R0000000001
|
|
10183
10588
|
title: Claims Key
|
|
10184
10589
|
domain:
|
|
10185
|
-
description: The domain name
|
|
10590
|
+
description: The domain name that was checked
|
|
10186
10591
|
examples:
|
|
10187
10592
|
- example.com
|
|
10188
10593
|
title: Domain
|
|
10189
10594
|
type: string
|
|
10190
10595
|
is_premium:
|
|
10191
10596
|
default: false
|
|
10192
|
-
description:
|
|
10597
|
+
description: True if the registry classifies this domain as premium (non-standard
|
|
10598
|
+
pricing)
|
|
10193
10599
|
title: Is Premium
|
|
10194
10600
|
type: boolean
|
|
10195
10601
|
premium_pricing:
|
|
10196
10602
|
anyOf:
|
|
10197
10603
|
- $ref: '#/components/schemas/PremiumPricingResponse'
|
|
10198
10604
|
- type: 'null'
|
|
10199
|
-
description: Premium pricing
|
|
10200
|
-
|
|
10605
|
+
description: Premium pricing per action (create / renew / transfer / restore).
|
|
10606
|
+
Present only when `is_premium` is true and the registry returned pricing.
|
|
10201
10607
|
reason:
|
|
10202
10608
|
anyOf:
|
|
10203
10609
|
- type: string
|
|
10204
10610
|
- type: 'null'
|
|
10611
|
+
description: Registry-supplied reason the domain is unavailable (e.g. 'Domain
|
|
10612
|
+
exists', 'Reserved', 'In Use'). May be null when the domain is available,
|
|
10613
|
+
or when the registry did not provide a reason.
|
|
10614
|
+
examples:
|
|
10615
|
+
- Domain exists
|
|
10205
10616
|
title: Reason
|
|
10206
10617
|
required:
|
|
10207
10618
|
- domain
|
|
@@ -10279,28 +10690,1199 @@ info:
|
|
|
10279
10690
|
\n\n"
|
|
10280
10691
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
10281
10692
|
title: OpusDNS API
|
|
10282
|
-
version: 2026-
|
|
10693
|
+
version: 2026-05-05-201917
|
|
10283
10694
|
x-logo:
|
|
10284
10695
|
altText: OpusDNS API Reference
|
|
10285
10696
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
10286
10697
|
openapi: 3.1.0
|
|
10287
10698
|
paths:
|
|
10288
|
-
/v1/
|
|
10699
|
+
/v1/ai-concierge/contexts/{context_id}:
|
|
10289
10700
|
get:
|
|
10290
|
-
|
|
10291
|
-
email forward alias. Only returns logs created after the email forward was
|
|
10292
|
-
created.
|
|
10293
|
-
operationId: get_email_forward_logs_by_alias_v1_archive_email_forward_logs_aliases__email_forward_alias_id__get
|
|
10701
|
+
operationId: get_context_v1_ai_concierge_contexts__context_id__get
|
|
10294
10702
|
parameters:
|
|
10295
10703
|
- in: path
|
|
10296
|
-
name:
|
|
10704
|
+
name: context_id
|
|
10297
10705
|
required: true
|
|
10298
10706
|
schema:
|
|
10299
10707
|
examples:
|
|
10300
|
-
-
|
|
10708
|
+
- ctx_01h45ytscbebyvny4gc8cr8ma2
|
|
10301
10709
|
format: typeid
|
|
10302
|
-
pattern: ^
|
|
10303
|
-
title:
|
|
10710
|
+
pattern: ^ctx_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
10711
|
+
title: Context Id
|
|
10712
|
+
type: string
|
|
10713
|
+
x-typeid-prefix: ctx
|
|
10714
|
+
responses:
|
|
10715
|
+
'200':
|
|
10716
|
+
content:
|
|
10717
|
+
application/json:
|
|
10718
|
+
schema:
|
|
10719
|
+
$ref: '#/components/schemas/Context'
|
|
10720
|
+
description: Successful Response
|
|
10721
|
+
'401':
|
|
10722
|
+
content:
|
|
10723
|
+
application/problem+json:
|
|
10724
|
+
example:
|
|
10725
|
+
code: ERROR_AUTHENTICATION
|
|
10726
|
+
detail: Additional error context.
|
|
10727
|
+
status: 401
|
|
10728
|
+
title: Authentication Error
|
|
10729
|
+
type: authentication
|
|
10730
|
+
schema:
|
|
10731
|
+
$ref: '#/components/schemas/Problem'
|
|
10732
|
+
description: Unauthorized
|
|
10733
|
+
'404':
|
|
10734
|
+
content:
|
|
10735
|
+
application/problem+json:
|
|
10736
|
+
example:
|
|
10737
|
+
code: ERROR_AI_CONCIERGE
|
|
10738
|
+
detail: AI Concierge memory resource not found
|
|
10739
|
+
status: 404
|
|
10740
|
+
title: AI Concierge memory resource not found.
|
|
10741
|
+
type: ai-concierge-memory-not-found
|
|
10742
|
+
schema:
|
|
10743
|
+
$ref: '#/components/schemas/Problem'
|
|
10744
|
+
description: Not Found
|
|
10745
|
+
'422':
|
|
10746
|
+
content:
|
|
10747
|
+
application/problem+json:
|
|
10748
|
+
schema:
|
|
10749
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
10750
|
+
description: Validation Error
|
|
10751
|
+
'502':
|
|
10752
|
+
content:
|
|
10753
|
+
application/problem+json:
|
|
10754
|
+
example:
|
|
10755
|
+
code: ERROR_AI_CONCIERGE
|
|
10756
|
+
detail: AI Concierge memory service error
|
|
10757
|
+
status: 502
|
|
10758
|
+
title: AI Concierge memory service error.
|
|
10759
|
+
type: ai-concierge-memory
|
|
10760
|
+
schema:
|
|
10761
|
+
$ref: '#/components/schemas/Problem'
|
|
10762
|
+
description: Bad Gateway
|
|
10763
|
+
security:
|
|
10764
|
+
- OAuth2PasswordBearer: []
|
|
10765
|
+
- APIKeyHeader: []
|
|
10766
|
+
summary: Get a context entry
|
|
10767
|
+
tags:
|
|
10768
|
+
- ai_concierge
|
|
10769
|
+
/v1/ai-concierge/conversations:
|
|
10770
|
+
get:
|
|
10771
|
+
description: List the authenticated organization's AI Concierge conversations.
|
|
10772
|
+
operationId: list_conversations_v1_ai_concierge_conversations_get
|
|
10773
|
+
parameters:
|
|
10774
|
+
- in: query
|
|
10775
|
+
name: page
|
|
10776
|
+
required: false
|
|
10777
|
+
schema:
|
|
10778
|
+
default: 1
|
|
10779
|
+
minimum: 1
|
|
10780
|
+
title: Page
|
|
10781
|
+
type: integer
|
|
10782
|
+
- in: query
|
|
10783
|
+
name: page_size
|
|
10784
|
+
required: false
|
|
10785
|
+
schema:
|
|
10786
|
+
default: 20
|
|
10787
|
+
maximum: 200
|
|
10788
|
+
minimum: 1
|
|
10789
|
+
title: Page Size
|
|
10790
|
+
type: integer
|
|
10791
|
+
- description: Comma-separated sort fields. Prefix with `-` for DESC.
|
|
10792
|
+
in: query
|
|
10793
|
+
name: sort
|
|
10794
|
+
required: false
|
|
10795
|
+
schema:
|
|
10796
|
+
anyOf:
|
|
10797
|
+
- type: string
|
|
10798
|
+
- type: 'null'
|
|
10799
|
+
description: Comma-separated sort fields. Prefix with `-` for DESC.
|
|
10800
|
+
title: Sort
|
|
10801
|
+
- description: Full-text search on title/summary.
|
|
10802
|
+
in: query
|
|
10803
|
+
name: q
|
|
10804
|
+
required: false
|
|
10805
|
+
schema:
|
|
10806
|
+
anyOf:
|
|
10807
|
+
- type: string
|
|
10808
|
+
- type: 'null'
|
|
10809
|
+
description: Full-text search on title/summary.
|
|
10810
|
+
title: Q
|
|
10811
|
+
responses:
|
|
10812
|
+
'200':
|
|
10813
|
+
content:
|
|
10814
|
+
application/json:
|
|
10815
|
+
schema:
|
|
10816
|
+
$ref: '#/components/schemas/ConversationListResponse'
|
|
10817
|
+
description: Successful Response
|
|
10818
|
+
'401':
|
|
10819
|
+
content:
|
|
10820
|
+
application/problem+json:
|
|
10821
|
+
example:
|
|
10822
|
+
code: ERROR_AUTHENTICATION
|
|
10823
|
+
detail: Additional error context.
|
|
10824
|
+
status: 401
|
|
10825
|
+
title: Authentication Error
|
|
10826
|
+
type: authentication
|
|
10827
|
+
schema:
|
|
10828
|
+
$ref: '#/components/schemas/Problem'
|
|
10829
|
+
description: Unauthorized
|
|
10830
|
+
'404':
|
|
10831
|
+
content:
|
|
10832
|
+
application/problem+json:
|
|
10833
|
+
example:
|
|
10834
|
+
code: ERROR_AI_CONCIERGE
|
|
10835
|
+
detail: AI Concierge memory resource not found
|
|
10836
|
+
status: 404
|
|
10837
|
+
title: AI Concierge memory resource not found.
|
|
10838
|
+
type: ai-concierge-memory-not-found
|
|
10839
|
+
schema:
|
|
10840
|
+
$ref: '#/components/schemas/Problem'
|
|
10841
|
+
description: Not Found
|
|
10842
|
+
'422':
|
|
10843
|
+
content:
|
|
10844
|
+
application/problem+json:
|
|
10845
|
+
schema:
|
|
10846
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
10847
|
+
description: Validation Error
|
|
10848
|
+
'502':
|
|
10849
|
+
content:
|
|
10850
|
+
application/problem+json:
|
|
10851
|
+
example:
|
|
10852
|
+
code: ERROR_AI_CONCIERGE
|
|
10853
|
+
detail: AI Concierge memory service error
|
|
10854
|
+
status: 502
|
|
10855
|
+
title: AI Concierge memory service error.
|
|
10856
|
+
type: ai-concierge-memory
|
|
10857
|
+
schema:
|
|
10858
|
+
$ref: '#/components/schemas/Problem'
|
|
10859
|
+
description: Bad Gateway
|
|
10860
|
+
security:
|
|
10861
|
+
- OAuth2PasswordBearer: []
|
|
10862
|
+
- APIKeyHeader: []
|
|
10863
|
+
summary: List AI Concierge conversations
|
|
10864
|
+
tags:
|
|
10865
|
+
- ai_concierge
|
|
10866
|
+
post:
|
|
10867
|
+
operationId: create_conversation_v1_ai_concierge_conversations_post
|
|
10868
|
+
requestBody:
|
|
10869
|
+
content:
|
|
10870
|
+
application/json:
|
|
10871
|
+
schema:
|
|
10872
|
+
$ref: '#/components/schemas/ConversationCreateRequest'
|
|
10873
|
+
required: true
|
|
10874
|
+
responses:
|
|
10875
|
+
'201':
|
|
10876
|
+
content:
|
|
10877
|
+
application/json:
|
|
10878
|
+
schema:
|
|
10879
|
+
$ref: '#/components/schemas/Conversation'
|
|
10880
|
+
description: Successful Response
|
|
10881
|
+
'401':
|
|
10882
|
+
content:
|
|
10883
|
+
application/problem+json:
|
|
10884
|
+
example:
|
|
10885
|
+
code: ERROR_AUTHENTICATION
|
|
10886
|
+
detail: Additional error context.
|
|
10887
|
+
status: 401
|
|
10888
|
+
title: Authentication Error
|
|
10889
|
+
type: authentication
|
|
10890
|
+
schema:
|
|
10891
|
+
$ref: '#/components/schemas/Problem'
|
|
10892
|
+
description: Unauthorized
|
|
10893
|
+
'404':
|
|
10894
|
+
content:
|
|
10895
|
+
application/problem+json:
|
|
10896
|
+
example:
|
|
10897
|
+
code: ERROR_AI_CONCIERGE
|
|
10898
|
+
detail: AI Concierge memory resource not found
|
|
10899
|
+
status: 404
|
|
10900
|
+
title: AI Concierge memory resource not found.
|
|
10901
|
+
type: ai-concierge-memory-not-found
|
|
10902
|
+
schema:
|
|
10903
|
+
$ref: '#/components/schemas/Problem'
|
|
10904
|
+
description: Not Found
|
|
10905
|
+
'422':
|
|
10906
|
+
content:
|
|
10907
|
+
application/problem+json:
|
|
10908
|
+
schema:
|
|
10909
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
10910
|
+
description: Validation Error
|
|
10911
|
+
'502':
|
|
10912
|
+
content:
|
|
10913
|
+
application/problem+json:
|
|
10914
|
+
example:
|
|
10915
|
+
code: ERROR_AI_CONCIERGE
|
|
10916
|
+
detail: AI Concierge memory service error
|
|
10917
|
+
status: 502
|
|
10918
|
+
title: AI Concierge memory service error.
|
|
10919
|
+
type: ai-concierge-memory
|
|
10920
|
+
schema:
|
|
10921
|
+
$ref: '#/components/schemas/Problem'
|
|
10922
|
+
description: Bad Gateway
|
|
10923
|
+
security:
|
|
10924
|
+
- OAuth2PasswordBearer: []
|
|
10925
|
+
- APIKeyHeader: []
|
|
10926
|
+
summary: Create an AI Concierge conversation
|
|
10927
|
+
tags:
|
|
10928
|
+
- ai_concierge
|
|
10929
|
+
/v1/ai-concierge/conversations/{conversation_id}:
|
|
10930
|
+
delete:
|
|
10931
|
+
description: Permanently delete a conversation, its messages, and any attached
|
|
10932
|
+
contexts.
|
|
10933
|
+
operationId: delete_conversation_v1_ai_concierge_conversations__conversation_id__delete
|
|
10934
|
+
parameters:
|
|
10935
|
+
- in: path
|
|
10936
|
+
name: conversation_id
|
|
10937
|
+
required: true
|
|
10938
|
+
schema:
|
|
10939
|
+
examples:
|
|
10940
|
+
- conv_01h45ytscbebyvny4gc8cr8ma2
|
|
10941
|
+
format: typeid
|
|
10942
|
+
pattern: ^conv_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
10943
|
+
title: Conversation Id
|
|
10944
|
+
type: string
|
|
10945
|
+
x-typeid-prefix: conv
|
|
10946
|
+
responses:
|
|
10947
|
+
'204':
|
|
10948
|
+
description: Successful Response
|
|
10949
|
+
'401':
|
|
10950
|
+
content:
|
|
10951
|
+
application/problem+json:
|
|
10952
|
+
example:
|
|
10953
|
+
code: ERROR_AUTHENTICATION
|
|
10954
|
+
detail: Additional error context.
|
|
10955
|
+
status: 401
|
|
10956
|
+
title: Authentication Error
|
|
10957
|
+
type: authentication
|
|
10958
|
+
schema:
|
|
10959
|
+
$ref: '#/components/schemas/Problem'
|
|
10960
|
+
description: Unauthorized
|
|
10961
|
+
'404':
|
|
10962
|
+
content:
|
|
10963
|
+
application/problem+json:
|
|
10964
|
+
example:
|
|
10965
|
+
code: ERROR_AI_CONCIERGE
|
|
10966
|
+
detail: AI Concierge memory resource not found
|
|
10967
|
+
status: 404
|
|
10968
|
+
title: AI Concierge memory resource not found.
|
|
10969
|
+
type: ai-concierge-memory-not-found
|
|
10970
|
+
schema:
|
|
10971
|
+
$ref: '#/components/schemas/Problem'
|
|
10972
|
+
description: Not Found
|
|
10973
|
+
'422':
|
|
10974
|
+
content:
|
|
10975
|
+
application/problem+json:
|
|
10976
|
+
schema:
|
|
10977
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
10978
|
+
description: Validation Error
|
|
10979
|
+
'502':
|
|
10980
|
+
content:
|
|
10981
|
+
application/problem+json:
|
|
10982
|
+
example:
|
|
10983
|
+
code: ERROR_AI_CONCIERGE
|
|
10984
|
+
detail: AI Concierge memory service error
|
|
10985
|
+
status: 502
|
|
10986
|
+
title: AI Concierge memory service error.
|
|
10987
|
+
type: ai-concierge-memory
|
|
10988
|
+
schema:
|
|
10989
|
+
$ref: '#/components/schemas/Problem'
|
|
10990
|
+
description: Bad Gateway
|
|
10991
|
+
security:
|
|
10992
|
+
- OAuth2PasswordBearer: []
|
|
10993
|
+
- APIKeyHeader: []
|
|
10994
|
+
summary: Delete a conversation
|
|
10995
|
+
tags:
|
|
10996
|
+
- ai_concierge
|
|
10997
|
+
get:
|
|
10998
|
+
operationId: get_conversation_v1_ai_concierge_conversations__conversation_id__get
|
|
10999
|
+
parameters:
|
|
11000
|
+
- in: path
|
|
11001
|
+
name: conversation_id
|
|
11002
|
+
required: true
|
|
11003
|
+
schema:
|
|
11004
|
+
examples:
|
|
11005
|
+
- conv_01h45ytscbebyvny4gc8cr8ma2
|
|
11006
|
+
format: typeid
|
|
11007
|
+
pattern: ^conv_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
11008
|
+
title: Conversation Id
|
|
11009
|
+
type: string
|
|
11010
|
+
x-typeid-prefix: conv
|
|
11011
|
+
responses:
|
|
11012
|
+
'200':
|
|
11013
|
+
content:
|
|
11014
|
+
application/json:
|
|
11015
|
+
schema:
|
|
11016
|
+
$ref: '#/components/schemas/Conversation'
|
|
11017
|
+
description: Successful Response
|
|
11018
|
+
'401':
|
|
11019
|
+
content:
|
|
11020
|
+
application/problem+json:
|
|
11021
|
+
example:
|
|
11022
|
+
code: ERROR_AUTHENTICATION
|
|
11023
|
+
detail: Additional error context.
|
|
11024
|
+
status: 401
|
|
11025
|
+
title: Authentication Error
|
|
11026
|
+
type: authentication
|
|
11027
|
+
schema:
|
|
11028
|
+
$ref: '#/components/schemas/Problem'
|
|
11029
|
+
description: Unauthorized
|
|
11030
|
+
'404':
|
|
11031
|
+
content:
|
|
11032
|
+
application/problem+json:
|
|
11033
|
+
example:
|
|
11034
|
+
code: ERROR_AI_CONCIERGE
|
|
11035
|
+
detail: AI Concierge memory resource not found
|
|
11036
|
+
status: 404
|
|
11037
|
+
title: AI Concierge memory resource not found.
|
|
11038
|
+
type: ai-concierge-memory-not-found
|
|
11039
|
+
schema:
|
|
11040
|
+
$ref: '#/components/schemas/Problem'
|
|
11041
|
+
description: Not Found
|
|
11042
|
+
'422':
|
|
11043
|
+
content:
|
|
11044
|
+
application/problem+json:
|
|
11045
|
+
schema:
|
|
11046
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
11047
|
+
description: Validation Error
|
|
11048
|
+
'502':
|
|
11049
|
+
content:
|
|
11050
|
+
application/problem+json:
|
|
11051
|
+
example:
|
|
11052
|
+
code: ERROR_AI_CONCIERGE
|
|
11053
|
+
detail: AI Concierge memory service error
|
|
11054
|
+
status: 502
|
|
11055
|
+
title: AI Concierge memory service error.
|
|
11056
|
+
type: ai-concierge-memory
|
|
11057
|
+
schema:
|
|
11058
|
+
$ref: '#/components/schemas/Problem'
|
|
11059
|
+
description: Bad Gateway
|
|
11060
|
+
security:
|
|
11061
|
+
- OAuth2PasswordBearer: []
|
|
11062
|
+
- APIKeyHeader: []
|
|
11063
|
+
summary: Get a conversation
|
|
11064
|
+
tags:
|
|
11065
|
+
- ai_concierge
|
|
11066
|
+
patch:
|
|
11067
|
+
description: Update conversation title or metadata. Supports optimistic concurrency
|
|
11068
|
+
via `If-Match`.
|
|
11069
|
+
operationId: patch_conversation_v1_ai_concierge_conversations__conversation_id__patch
|
|
11070
|
+
parameters:
|
|
11071
|
+
- in: path
|
|
11072
|
+
name: conversation_id
|
|
11073
|
+
required: true
|
|
11074
|
+
schema:
|
|
11075
|
+
examples:
|
|
11076
|
+
- conv_01h45ytscbebyvny4gc8cr8ma2
|
|
11077
|
+
format: typeid
|
|
11078
|
+
pattern: ^conv_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
11079
|
+
title: Conversation Id
|
|
11080
|
+
type: string
|
|
11081
|
+
x-typeid-prefix: conv
|
|
11082
|
+
- in: header
|
|
11083
|
+
name: If-Match
|
|
11084
|
+
required: false
|
|
11085
|
+
schema:
|
|
11086
|
+
anyOf:
|
|
11087
|
+
- type: string
|
|
11088
|
+
- type: 'null'
|
|
11089
|
+
title: If-Match
|
|
11090
|
+
requestBody:
|
|
11091
|
+
content:
|
|
11092
|
+
application/json:
|
|
11093
|
+
schema:
|
|
11094
|
+
$ref: '#/components/schemas/ConversationPatchRequest'
|
|
11095
|
+
required: true
|
|
11096
|
+
responses:
|
|
11097
|
+
'200':
|
|
11098
|
+
content:
|
|
11099
|
+
application/json:
|
|
11100
|
+
schema:
|
|
11101
|
+
$ref: '#/components/schemas/Conversation'
|
|
11102
|
+
description: Successful Response
|
|
11103
|
+
'401':
|
|
11104
|
+
content:
|
|
11105
|
+
application/problem+json:
|
|
11106
|
+
example:
|
|
11107
|
+
code: ERROR_AUTHENTICATION
|
|
11108
|
+
detail: Additional error context.
|
|
11109
|
+
status: 401
|
|
11110
|
+
title: Authentication Error
|
|
11111
|
+
type: authentication
|
|
11112
|
+
schema:
|
|
11113
|
+
$ref: '#/components/schemas/Problem'
|
|
11114
|
+
description: Unauthorized
|
|
11115
|
+
'404':
|
|
11116
|
+
content:
|
|
11117
|
+
application/problem+json:
|
|
11118
|
+
example:
|
|
11119
|
+
code: ERROR_AI_CONCIERGE
|
|
11120
|
+
detail: AI Concierge memory resource not found
|
|
11121
|
+
status: 404
|
|
11122
|
+
title: AI Concierge memory resource not found.
|
|
11123
|
+
type: ai-concierge-memory-not-found
|
|
11124
|
+
schema:
|
|
11125
|
+
$ref: '#/components/schemas/Problem'
|
|
11126
|
+
description: Not Found
|
|
11127
|
+
'422':
|
|
11128
|
+
content:
|
|
11129
|
+
application/problem+json:
|
|
11130
|
+
schema:
|
|
11131
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
11132
|
+
description: Validation Error
|
|
11133
|
+
'502':
|
|
11134
|
+
content:
|
|
11135
|
+
application/problem+json:
|
|
11136
|
+
example:
|
|
11137
|
+
code: ERROR_AI_CONCIERGE
|
|
11138
|
+
detail: AI Concierge memory service error
|
|
11139
|
+
status: 502
|
|
11140
|
+
title: AI Concierge memory service error.
|
|
11141
|
+
type: ai-concierge-memory
|
|
11142
|
+
schema:
|
|
11143
|
+
$ref: '#/components/schemas/Problem'
|
|
11144
|
+
description: Bad Gateway
|
|
11145
|
+
security:
|
|
11146
|
+
- OAuth2PasswordBearer: []
|
|
11147
|
+
- APIKeyHeader: []
|
|
11148
|
+
summary: Update a conversation
|
|
11149
|
+
tags:
|
|
11150
|
+
- ai_concierge
|
|
11151
|
+
/v1/ai-concierge/conversations/{conversation_id}/contexts:
|
|
11152
|
+
get:
|
|
11153
|
+
operationId: list_contexts_v1_ai_concierge_conversations__conversation_id__contexts_get
|
|
11154
|
+
parameters:
|
|
11155
|
+
- in: path
|
|
11156
|
+
name: conversation_id
|
|
11157
|
+
required: true
|
|
11158
|
+
schema:
|
|
11159
|
+
examples:
|
|
11160
|
+
- conv_01h45ytscbebyvny4gc8cr8ma2
|
|
11161
|
+
format: typeid
|
|
11162
|
+
pattern: ^conv_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
11163
|
+
title: Conversation Id
|
|
11164
|
+
type: string
|
|
11165
|
+
x-typeid-prefix: conv
|
|
11166
|
+
- in: query
|
|
11167
|
+
name: page
|
|
11168
|
+
required: false
|
|
11169
|
+
schema:
|
|
11170
|
+
default: 1
|
|
11171
|
+
minimum: 1
|
|
11172
|
+
title: Page
|
|
11173
|
+
type: integer
|
|
11174
|
+
- in: query
|
|
11175
|
+
name: page_size
|
|
11176
|
+
required: false
|
|
11177
|
+
schema:
|
|
11178
|
+
default: 20
|
|
11179
|
+
maximum: 200
|
|
11180
|
+
minimum: 1
|
|
11181
|
+
title: Page Size
|
|
11182
|
+
type: integer
|
|
11183
|
+
responses:
|
|
11184
|
+
'200':
|
|
11185
|
+
content:
|
|
11186
|
+
application/json:
|
|
11187
|
+
schema:
|
|
11188
|
+
$ref: '#/components/schemas/ContextListResponse'
|
|
11189
|
+
description: Successful Response
|
|
11190
|
+
'401':
|
|
11191
|
+
content:
|
|
11192
|
+
application/problem+json:
|
|
11193
|
+
example:
|
|
11194
|
+
code: ERROR_AUTHENTICATION
|
|
11195
|
+
detail: Additional error context.
|
|
11196
|
+
status: 401
|
|
11197
|
+
title: Authentication Error
|
|
11198
|
+
type: authentication
|
|
11199
|
+
schema:
|
|
11200
|
+
$ref: '#/components/schemas/Problem'
|
|
11201
|
+
description: Unauthorized
|
|
11202
|
+
'404':
|
|
11203
|
+
content:
|
|
11204
|
+
application/problem+json:
|
|
11205
|
+
example:
|
|
11206
|
+
code: ERROR_AI_CONCIERGE
|
|
11207
|
+
detail: AI Concierge memory resource not found
|
|
11208
|
+
status: 404
|
|
11209
|
+
title: AI Concierge memory resource not found.
|
|
11210
|
+
type: ai-concierge-memory-not-found
|
|
11211
|
+
schema:
|
|
11212
|
+
$ref: '#/components/schemas/Problem'
|
|
11213
|
+
description: Not Found
|
|
11214
|
+
'422':
|
|
11215
|
+
content:
|
|
11216
|
+
application/problem+json:
|
|
11217
|
+
schema:
|
|
11218
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
11219
|
+
description: Validation Error
|
|
11220
|
+
'502':
|
|
11221
|
+
content:
|
|
11222
|
+
application/problem+json:
|
|
11223
|
+
example:
|
|
11224
|
+
code: ERROR_AI_CONCIERGE
|
|
11225
|
+
detail: AI Concierge memory service error
|
|
11226
|
+
status: 502
|
|
11227
|
+
title: AI Concierge memory service error.
|
|
11228
|
+
type: ai-concierge-memory
|
|
11229
|
+
schema:
|
|
11230
|
+
$ref: '#/components/schemas/Problem'
|
|
11231
|
+
description: Bad Gateway
|
|
11232
|
+
security:
|
|
11233
|
+
- OAuth2PasswordBearer: []
|
|
11234
|
+
- APIKeyHeader: []
|
|
11235
|
+
summary: List contexts attached to a conversation
|
|
11236
|
+
tags:
|
|
11237
|
+
- ai_concierge
|
|
11238
|
+
post:
|
|
11239
|
+
operationId: create_context_v1_ai_concierge_conversations__conversation_id__contexts_post
|
|
11240
|
+
parameters:
|
|
11241
|
+
- in: path
|
|
11242
|
+
name: conversation_id
|
|
11243
|
+
required: true
|
|
11244
|
+
schema:
|
|
11245
|
+
examples:
|
|
11246
|
+
- conv_01h45ytscbebyvny4gc8cr8ma2
|
|
11247
|
+
format: typeid
|
|
11248
|
+
pattern: ^conv_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
11249
|
+
title: Conversation Id
|
|
11250
|
+
type: string
|
|
11251
|
+
x-typeid-prefix: conv
|
|
11252
|
+
requestBody:
|
|
11253
|
+
content:
|
|
11254
|
+
application/json:
|
|
11255
|
+
schema:
|
|
11256
|
+
$ref: '#/components/schemas/ContextCreateRequest'
|
|
11257
|
+
required: true
|
|
11258
|
+
responses:
|
|
11259
|
+
'201':
|
|
11260
|
+
content:
|
|
11261
|
+
application/json:
|
|
11262
|
+
schema:
|
|
11263
|
+
$ref: '#/components/schemas/Context'
|
|
11264
|
+
description: Successful Response
|
|
11265
|
+
'401':
|
|
11266
|
+
content:
|
|
11267
|
+
application/problem+json:
|
|
11268
|
+
example:
|
|
11269
|
+
code: ERROR_AUTHENTICATION
|
|
11270
|
+
detail: Additional error context.
|
|
11271
|
+
status: 401
|
|
11272
|
+
title: Authentication Error
|
|
11273
|
+
type: authentication
|
|
11274
|
+
schema:
|
|
11275
|
+
$ref: '#/components/schemas/Problem'
|
|
11276
|
+
description: Unauthorized
|
|
11277
|
+
'404':
|
|
11278
|
+
content:
|
|
11279
|
+
application/problem+json:
|
|
11280
|
+
example:
|
|
11281
|
+
code: ERROR_AI_CONCIERGE
|
|
11282
|
+
detail: AI Concierge memory resource not found
|
|
11283
|
+
status: 404
|
|
11284
|
+
title: AI Concierge memory resource not found.
|
|
11285
|
+
type: ai-concierge-memory-not-found
|
|
11286
|
+
schema:
|
|
11287
|
+
$ref: '#/components/schemas/Problem'
|
|
11288
|
+
description: Not Found
|
|
11289
|
+
'422':
|
|
11290
|
+
content:
|
|
11291
|
+
application/problem+json:
|
|
11292
|
+
schema:
|
|
11293
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
11294
|
+
description: Validation Error
|
|
11295
|
+
'502':
|
|
11296
|
+
content:
|
|
11297
|
+
application/problem+json:
|
|
11298
|
+
example:
|
|
11299
|
+
code: ERROR_AI_CONCIERGE
|
|
11300
|
+
detail: AI Concierge memory service error
|
|
11301
|
+
status: 502
|
|
11302
|
+
title: AI Concierge memory service error.
|
|
11303
|
+
type: ai-concierge-memory
|
|
11304
|
+
schema:
|
|
11305
|
+
$ref: '#/components/schemas/Problem'
|
|
11306
|
+
description: Bad Gateway
|
|
11307
|
+
security:
|
|
11308
|
+
- OAuth2PasswordBearer: []
|
|
11309
|
+
- APIKeyHeader: []
|
|
11310
|
+
summary: Attach a context to a conversation
|
|
11311
|
+
tags:
|
|
11312
|
+
- ai_concierge
|
|
11313
|
+
/v1/ai-concierge/conversations/{conversation_id}/messages:
|
|
11314
|
+
get:
|
|
11315
|
+
operationId: list_messages_v1_ai_concierge_conversations__conversation_id__messages_get
|
|
11316
|
+
parameters:
|
|
11317
|
+
- in: path
|
|
11318
|
+
name: conversation_id
|
|
11319
|
+
required: true
|
|
11320
|
+
schema:
|
|
11321
|
+
examples:
|
|
11322
|
+
- conv_01h45ytscbebyvny4gc8cr8ma2
|
|
11323
|
+
format: typeid
|
|
11324
|
+
pattern: ^conv_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
11325
|
+
title: Conversation Id
|
|
11326
|
+
type: string
|
|
11327
|
+
x-typeid-prefix: conv
|
|
11328
|
+
- in: query
|
|
11329
|
+
name: page
|
|
11330
|
+
required: false
|
|
11331
|
+
schema:
|
|
11332
|
+
default: 1
|
|
11333
|
+
minimum: 1
|
|
11334
|
+
title: Page
|
|
11335
|
+
type: integer
|
|
11336
|
+
- in: query
|
|
11337
|
+
name: page_size
|
|
11338
|
+
required: false
|
|
11339
|
+
schema:
|
|
11340
|
+
default: 20
|
|
11341
|
+
maximum: 200
|
|
11342
|
+
minimum: 1
|
|
11343
|
+
title: Page Size
|
|
11344
|
+
type: integer
|
|
11345
|
+
- description: If set, returns last N messages and overrides pagination.
|
|
11346
|
+
in: query
|
|
11347
|
+
name: recent
|
|
11348
|
+
required: false
|
|
11349
|
+
schema:
|
|
11350
|
+
anyOf:
|
|
11351
|
+
- maximum: 200
|
|
11352
|
+
minimum: 1
|
|
11353
|
+
type: integer
|
|
11354
|
+
- type: 'null'
|
|
11355
|
+
description: If set, returns last N messages and overrides pagination.
|
|
11356
|
+
title: Recent
|
|
11357
|
+
- description: Comma-separated tokens to exclude (case-insensitive). Supports
|
|
11358
|
+
`tools`.
|
|
11359
|
+
in: query
|
|
11360
|
+
name: exclude
|
|
11361
|
+
required: false
|
|
11362
|
+
schema:
|
|
11363
|
+
anyOf:
|
|
11364
|
+
- type: string
|
|
11365
|
+
- type: 'null'
|
|
11366
|
+
description: Comma-separated tokens to exclude (case-insensitive). Supports
|
|
11367
|
+
`tools`.
|
|
11368
|
+
title: Exclude
|
|
11369
|
+
responses:
|
|
11370
|
+
'200':
|
|
11371
|
+
content:
|
|
11372
|
+
application/json:
|
|
11373
|
+
schema:
|
|
11374
|
+
$ref: '#/components/schemas/MessageListResponse'
|
|
11375
|
+
description: Successful Response
|
|
11376
|
+
'401':
|
|
11377
|
+
content:
|
|
11378
|
+
application/problem+json:
|
|
11379
|
+
example:
|
|
11380
|
+
code: ERROR_AUTHENTICATION
|
|
11381
|
+
detail: Additional error context.
|
|
11382
|
+
status: 401
|
|
11383
|
+
title: Authentication Error
|
|
11384
|
+
type: authentication
|
|
11385
|
+
schema:
|
|
11386
|
+
$ref: '#/components/schemas/Problem'
|
|
11387
|
+
description: Unauthorized
|
|
11388
|
+
'404':
|
|
11389
|
+
content:
|
|
11390
|
+
application/problem+json:
|
|
11391
|
+
example:
|
|
11392
|
+
code: ERROR_AI_CONCIERGE
|
|
11393
|
+
detail: AI Concierge memory resource not found
|
|
11394
|
+
status: 404
|
|
11395
|
+
title: AI Concierge memory resource not found.
|
|
11396
|
+
type: ai-concierge-memory-not-found
|
|
11397
|
+
schema:
|
|
11398
|
+
$ref: '#/components/schemas/Problem'
|
|
11399
|
+
description: Not Found
|
|
11400
|
+
'422':
|
|
11401
|
+
content:
|
|
11402
|
+
application/problem+json:
|
|
11403
|
+
schema:
|
|
11404
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
11405
|
+
description: Validation Error
|
|
11406
|
+
'502':
|
|
11407
|
+
content:
|
|
11408
|
+
application/problem+json:
|
|
11409
|
+
example:
|
|
11410
|
+
code: ERROR_AI_CONCIERGE
|
|
11411
|
+
detail: AI Concierge memory service error
|
|
11412
|
+
status: 502
|
|
11413
|
+
title: AI Concierge memory service error.
|
|
11414
|
+
type: ai-concierge-memory
|
|
11415
|
+
schema:
|
|
11416
|
+
$ref: '#/components/schemas/Problem'
|
|
11417
|
+
description: Bad Gateway
|
|
11418
|
+
security:
|
|
11419
|
+
- OAuth2PasswordBearer: []
|
|
11420
|
+
- APIKeyHeader: []
|
|
11421
|
+
summary: List messages in a conversation
|
|
11422
|
+
tags:
|
|
11423
|
+
- ai_concierge
|
|
11424
|
+
post:
|
|
11425
|
+
operationId: create_message_v1_ai_concierge_conversations__conversation_id__messages_post
|
|
11426
|
+
parameters:
|
|
11427
|
+
- in: path
|
|
11428
|
+
name: conversation_id
|
|
11429
|
+
required: true
|
|
11430
|
+
schema:
|
|
11431
|
+
examples:
|
|
11432
|
+
- conv_01h45ytscbebyvny4gc8cr8ma2
|
|
11433
|
+
format: typeid
|
|
11434
|
+
pattern: ^conv_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
11435
|
+
title: Conversation Id
|
|
11436
|
+
type: string
|
|
11437
|
+
x-typeid-prefix: conv
|
|
11438
|
+
requestBody:
|
|
11439
|
+
content:
|
|
11440
|
+
application/json:
|
|
11441
|
+
schema:
|
|
11442
|
+
$ref: '#/components/schemas/MessageCreateRequest'
|
|
11443
|
+
required: true
|
|
11444
|
+
responses:
|
|
11445
|
+
'201':
|
|
11446
|
+
content:
|
|
11447
|
+
application/json:
|
|
11448
|
+
schema:
|
|
11449
|
+
$ref: '#/components/schemas/Message'
|
|
11450
|
+
description: Successful Response
|
|
11451
|
+
'401':
|
|
11452
|
+
content:
|
|
11453
|
+
application/problem+json:
|
|
11454
|
+
example:
|
|
11455
|
+
code: ERROR_AUTHENTICATION
|
|
11456
|
+
detail: Additional error context.
|
|
11457
|
+
status: 401
|
|
11458
|
+
title: Authentication Error
|
|
11459
|
+
type: authentication
|
|
11460
|
+
schema:
|
|
11461
|
+
$ref: '#/components/schemas/Problem'
|
|
11462
|
+
description: Unauthorized
|
|
11463
|
+
'404':
|
|
11464
|
+
content:
|
|
11465
|
+
application/problem+json:
|
|
11466
|
+
example:
|
|
11467
|
+
code: ERROR_AI_CONCIERGE
|
|
11468
|
+
detail: AI Concierge memory resource not found
|
|
11469
|
+
status: 404
|
|
11470
|
+
title: AI Concierge memory resource not found.
|
|
11471
|
+
type: ai-concierge-memory-not-found
|
|
11472
|
+
schema:
|
|
11473
|
+
$ref: '#/components/schemas/Problem'
|
|
11474
|
+
description: Not Found
|
|
11475
|
+
'422':
|
|
11476
|
+
content:
|
|
11477
|
+
application/problem+json:
|
|
11478
|
+
schema:
|
|
11479
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
11480
|
+
description: Validation Error
|
|
11481
|
+
'502':
|
|
11482
|
+
content:
|
|
11483
|
+
application/problem+json:
|
|
11484
|
+
example:
|
|
11485
|
+
code: ERROR_AI_CONCIERGE
|
|
11486
|
+
detail: AI Concierge memory service error
|
|
11487
|
+
status: 502
|
|
11488
|
+
title: AI Concierge memory service error.
|
|
11489
|
+
type: ai-concierge-memory
|
|
11490
|
+
schema:
|
|
11491
|
+
$ref: '#/components/schemas/Problem'
|
|
11492
|
+
description: Bad Gateway
|
|
11493
|
+
security:
|
|
11494
|
+
- OAuth2PasswordBearer: []
|
|
11495
|
+
- APIKeyHeader: []
|
|
11496
|
+
summary: Append a message to a conversation
|
|
11497
|
+
tags:
|
|
11498
|
+
- ai_concierge
|
|
11499
|
+
/v1/ai-concierge/conversations/{conversation_id}/messages/{message_id}:
|
|
11500
|
+
get:
|
|
11501
|
+
operationId: get_message_v1_ai_concierge_conversations__conversation_id__messages__message_id__get
|
|
11502
|
+
parameters:
|
|
11503
|
+
- in: path
|
|
11504
|
+
name: conversation_id
|
|
11505
|
+
required: true
|
|
11506
|
+
schema:
|
|
11507
|
+
examples:
|
|
11508
|
+
- conv_01h45ytscbebyvny4gc8cr8ma2
|
|
11509
|
+
format: typeid
|
|
11510
|
+
pattern: ^conv_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
11511
|
+
title: Conversation Id
|
|
11512
|
+
type: string
|
|
11513
|
+
x-typeid-prefix: conv
|
|
11514
|
+
- in: path
|
|
11515
|
+
name: message_id
|
|
11516
|
+
required: true
|
|
11517
|
+
schema:
|
|
11518
|
+
examples:
|
|
11519
|
+
- msg_01h45ytscbebyvny4gc8cr8ma2
|
|
11520
|
+
format: typeid
|
|
11521
|
+
pattern: ^msg_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
11522
|
+
title: Message Id
|
|
11523
|
+
type: string
|
|
11524
|
+
x-typeid-prefix: msg
|
|
11525
|
+
responses:
|
|
11526
|
+
'200':
|
|
11527
|
+
content:
|
|
11528
|
+
application/json:
|
|
11529
|
+
schema:
|
|
11530
|
+
$ref: '#/components/schemas/Message'
|
|
11531
|
+
description: Successful Response
|
|
11532
|
+
'401':
|
|
11533
|
+
content:
|
|
11534
|
+
application/problem+json:
|
|
11535
|
+
example:
|
|
11536
|
+
code: ERROR_AUTHENTICATION
|
|
11537
|
+
detail: Additional error context.
|
|
11538
|
+
status: 401
|
|
11539
|
+
title: Authentication Error
|
|
11540
|
+
type: authentication
|
|
11541
|
+
schema:
|
|
11542
|
+
$ref: '#/components/schemas/Problem'
|
|
11543
|
+
description: Unauthorized
|
|
11544
|
+
'404':
|
|
11545
|
+
content:
|
|
11546
|
+
application/problem+json:
|
|
11547
|
+
example:
|
|
11548
|
+
code: ERROR_AI_CONCIERGE
|
|
11549
|
+
detail: AI Concierge memory resource not found
|
|
11550
|
+
status: 404
|
|
11551
|
+
title: AI Concierge memory resource not found.
|
|
11552
|
+
type: ai-concierge-memory-not-found
|
|
11553
|
+
schema:
|
|
11554
|
+
$ref: '#/components/schemas/Problem'
|
|
11555
|
+
description: Not Found
|
|
11556
|
+
'422':
|
|
11557
|
+
content:
|
|
11558
|
+
application/problem+json:
|
|
11559
|
+
schema:
|
|
11560
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
11561
|
+
description: Validation Error
|
|
11562
|
+
'502':
|
|
11563
|
+
content:
|
|
11564
|
+
application/problem+json:
|
|
11565
|
+
example:
|
|
11566
|
+
code: ERROR_AI_CONCIERGE
|
|
11567
|
+
detail: AI Concierge memory service error
|
|
11568
|
+
status: 502
|
|
11569
|
+
title: AI Concierge memory service error.
|
|
11570
|
+
type: ai-concierge-memory
|
|
11571
|
+
schema:
|
|
11572
|
+
$ref: '#/components/schemas/Problem'
|
|
11573
|
+
description: Bad Gateway
|
|
11574
|
+
security:
|
|
11575
|
+
- OAuth2PasswordBearer: []
|
|
11576
|
+
- APIKeyHeader: []
|
|
11577
|
+
summary: Get a message
|
|
11578
|
+
tags:
|
|
11579
|
+
- ai_concierge
|
|
11580
|
+
/v1/ai-concierge/memory/facts:
|
|
11581
|
+
get:
|
|
11582
|
+
description: List long-term, organization-scoped memory facts available to the
|
|
11583
|
+
AI Concierge.
|
|
11584
|
+
operationId: list_memory_facts_v1_ai_concierge_memory_facts_get
|
|
11585
|
+
parameters:
|
|
11586
|
+
- in: query
|
|
11587
|
+
name: limit
|
|
11588
|
+
required: false
|
|
11589
|
+
schema:
|
|
11590
|
+
default: 50
|
|
11591
|
+
maximum: 200
|
|
11592
|
+
minimum: 1
|
|
11593
|
+
title: Limit
|
|
11594
|
+
type: integer
|
|
11595
|
+
- in: query
|
|
11596
|
+
name: cursor
|
|
11597
|
+
required: false
|
|
11598
|
+
schema:
|
|
11599
|
+
anyOf:
|
|
11600
|
+
- type: string
|
|
11601
|
+
- type: 'null'
|
|
11602
|
+
title: Cursor
|
|
11603
|
+
- in: query
|
|
11604
|
+
name: kind
|
|
11605
|
+
required: false
|
|
11606
|
+
schema:
|
|
11607
|
+
anyOf:
|
|
11608
|
+
- type: string
|
|
11609
|
+
- type: 'null'
|
|
11610
|
+
title: Kind
|
|
11611
|
+
responses:
|
|
11612
|
+
'200':
|
|
11613
|
+
content:
|
|
11614
|
+
application/json:
|
|
11615
|
+
schema:
|
|
11616
|
+
$ref: '#/components/schemas/MemoryFactListResponse'
|
|
11617
|
+
description: Successful Response
|
|
11618
|
+
'401':
|
|
11619
|
+
content:
|
|
11620
|
+
application/problem+json:
|
|
11621
|
+
example:
|
|
11622
|
+
code: ERROR_AUTHENTICATION
|
|
11623
|
+
detail: Additional error context.
|
|
11624
|
+
status: 401
|
|
11625
|
+
title: Authentication Error
|
|
11626
|
+
type: authentication
|
|
11627
|
+
schema:
|
|
11628
|
+
$ref: '#/components/schemas/Problem'
|
|
11629
|
+
description: Unauthorized
|
|
11630
|
+
'404':
|
|
11631
|
+
content:
|
|
11632
|
+
application/problem+json:
|
|
11633
|
+
example:
|
|
11634
|
+
code: ERROR_AI_CONCIERGE
|
|
11635
|
+
detail: AI Concierge memory resource not found
|
|
11636
|
+
status: 404
|
|
11637
|
+
title: AI Concierge memory resource not found.
|
|
11638
|
+
type: ai-concierge-memory-not-found
|
|
11639
|
+
schema:
|
|
11640
|
+
$ref: '#/components/schemas/Problem'
|
|
11641
|
+
description: Not Found
|
|
11642
|
+
'422':
|
|
11643
|
+
content:
|
|
11644
|
+
application/problem+json:
|
|
11645
|
+
schema:
|
|
11646
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
11647
|
+
description: Validation Error
|
|
11648
|
+
'502':
|
|
11649
|
+
content:
|
|
11650
|
+
application/problem+json:
|
|
11651
|
+
example:
|
|
11652
|
+
code: ERROR_AI_CONCIERGE
|
|
11653
|
+
detail: AI Concierge memory service error
|
|
11654
|
+
status: 502
|
|
11655
|
+
title: AI Concierge memory service error.
|
|
11656
|
+
type: ai-concierge-memory
|
|
11657
|
+
schema:
|
|
11658
|
+
$ref: '#/components/schemas/Problem'
|
|
11659
|
+
description: Bad Gateway
|
|
11660
|
+
security:
|
|
11661
|
+
- OAuth2PasswordBearer: []
|
|
11662
|
+
- APIKeyHeader: []
|
|
11663
|
+
summary: List long-term memory facts
|
|
11664
|
+
tags:
|
|
11665
|
+
- ai_concierge
|
|
11666
|
+
post:
|
|
11667
|
+
operationId: create_memory_fact_v1_ai_concierge_memory_facts_post
|
|
11668
|
+
requestBody:
|
|
11669
|
+
content:
|
|
11670
|
+
application/json:
|
|
11671
|
+
schema:
|
|
11672
|
+
$ref: '#/components/schemas/MemoryFactCreateRequest'
|
|
11673
|
+
required: true
|
|
11674
|
+
responses:
|
|
11675
|
+
'201':
|
|
11676
|
+
content:
|
|
11677
|
+
application/json:
|
|
11678
|
+
schema:
|
|
11679
|
+
$ref: '#/components/schemas/MemoryFact'
|
|
11680
|
+
description: Successful Response
|
|
11681
|
+
'401':
|
|
11682
|
+
content:
|
|
11683
|
+
application/problem+json:
|
|
11684
|
+
example:
|
|
11685
|
+
code: ERROR_AUTHENTICATION
|
|
11686
|
+
detail: Additional error context.
|
|
11687
|
+
status: 401
|
|
11688
|
+
title: Authentication Error
|
|
11689
|
+
type: authentication
|
|
11690
|
+
schema:
|
|
11691
|
+
$ref: '#/components/schemas/Problem'
|
|
11692
|
+
description: Unauthorized
|
|
11693
|
+
'404':
|
|
11694
|
+
content:
|
|
11695
|
+
application/problem+json:
|
|
11696
|
+
example:
|
|
11697
|
+
code: ERROR_AI_CONCIERGE
|
|
11698
|
+
detail: AI Concierge memory resource not found
|
|
11699
|
+
status: 404
|
|
11700
|
+
title: AI Concierge memory resource not found.
|
|
11701
|
+
type: ai-concierge-memory-not-found
|
|
11702
|
+
schema:
|
|
11703
|
+
$ref: '#/components/schemas/Problem'
|
|
11704
|
+
description: Not Found
|
|
11705
|
+
'422':
|
|
11706
|
+
content:
|
|
11707
|
+
application/problem+json:
|
|
11708
|
+
schema:
|
|
11709
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
11710
|
+
description: Validation Error
|
|
11711
|
+
'502':
|
|
11712
|
+
content:
|
|
11713
|
+
application/problem+json:
|
|
11714
|
+
example:
|
|
11715
|
+
code: ERROR_AI_CONCIERGE
|
|
11716
|
+
detail: AI Concierge memory service error
|
|
11717
|
+
status: 502
|
|
11718
|
+
title: AI Concierge memory service error.
|
|
11719
|
+
type: ai-concierge-memory
|
|
11720
|
+
schema:
|
|
11721
|
+
$ref: '#/components/schemas/Problem'
|
|
11722
|
+
description: Bad Gateway
|
|
11723
|
+
security:
|
|
11724
|
+
- OAuth2PasswordBearer: []
|
|
11725
|
+
- APIKeyHeader: []
|
|
11726
|
+
summary: Create a long-term memory fact
|
|
11727
|
+
tags:
|
|
11728
|
+
- ai_concierge
|
|
11729
|
+
/v1/ai-concierge/memory/facts/{fact_id}:
|
|
11730
|
+
delete:
|
|
11731
|
+
operationId: delete_memory_fact_v1_ai_concierge_memory_facts__fact_id__delete
|
|
11732
|
+
parameters:
|
|
11733
|
+
- in: path
|
|
11734
|
+
name: fact_id
|
|
11735
|
+
required: true
|
|
11736
|
+
schema:
|
|
11737
|
+
examples:
|
|
11738
|
+
- fact_01h45ytscbebyvny4gc8cr8ma2
|
|
11739
|
+
format: typeid
|
|
11740
|
+
pattern: ^fact_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
11741
|
+
title: Fact Id
|
|
11742
|
+
type: string
|
|
11743
|
+
x-typeid-prefix: fact
|
|
11744
|
+
responses:
|
|
11745
|
+
'204':
|
|
11746
|
+
description: Successful Response
|
|
11747
|
+
'401':
|
|
11748
|
+
content:
|
|
11749
|
+
application/problem+json:
|
|
11750
|
+
example:
|
|
11751
|
+
code: ERROR_AUTHENTICATION
|
|
11752
|
+
detail: Additional error context.
|
|
11753
|
+
status: 401
|
|
11754
|
+
title: Authentication Error
|
|
11755
|
+
type: authentication
|
|
11756
|
+
schema:
|
|
11757
|
+
$ref: '#/components/schemas/Problem'
|
|
11758
|
+
description: Unauthorized
|
|
11759
|
+
'404':
|
|
11760
|
+
content:
|
|
11761
|
+
application/problem+json:
|
|
11762
|
+
example:
|
|
11763
|
+
code: ERROR_AI_CONCIERGE
|
|
11764
|
+
detail: AI Concierge memory resource not found
|
|
11765
|
+
status: 404
|
|
11766
|
+
title: AI Concierge memory resource not found.
|
|
11767
|
+
type: ai-concierge-memory-not-found
|
|
11768
|
+
schema:
|
|
11769
|
+
$ref: '#/components/schemas/Problem'
|
|
11770
|
+
description: Not Found
|
|
11771
|
+
'422':
|
|
11772
|
+
content:
|
|
11773
|
+
application/problem+json:
|
|
11774
|
+
schema:
|
|
11775
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
11776
|
+
description: Validation Error
|
|
11777
|
+
'502':
|
|
11778
|
+
content:
|
|
11779
|
+
application/problem+json:
|
|
11780
|
+
example:
|
|
11781
|
+
code: ERROR_AI_CONCIERGE
|
|
11782
|
+
detail: AI Concierge memory service error
|
|
11783
|
+
status: 502
|
|
11784
|
+
title: AI Concierge memory service error.
|
|
11785
|
+
type: ai-concierge-memory
|
|
11786
|
+
schema:
|
|
11787
|
+
$ref: '#/components/schemas/Problem'
|
|
11788
|
+
description: Bad Gateway
|
|
11789
|
+
security:
|
|
11790
|
+
- OAuth2PasswordBearer: []
|
|
11791
|
+
- APIKeyHeader: []
|
|
11792
|
+
summary: Delete a long-term memory fact
|
|
11793
|
+
tags:
|
|
11794
|
+
- ai_concierge
|
|
11795
|
+
patch:
|
|
11796
|
+
operationId: patch_memory_fact_v1_ai_concierge_memory_facts__fact_id__patch
|
|
11797
|
+
parameters:
|
|
11798
|
+
- in: path
|
|
11799
|
+
name: fact_id
|
|
11800
|
+
required: true
|
|
11801
|
+
schema:
|
|
11802
|
+
examples:
|
|
11803
|
+
- fact_01h45ytscbebyvny4gc8cr8ma2
|
|
11804
|
+
format: typeid
|
|
11805
|
+
pattern: ^fact_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
11806
|
+
title: Fact Id
|
|
11807
|
+
type: string
|
|
11808
|
+
x-typeid-prefix: fact
|
|
11809
|
+
requestBody:
|
|
11810
|
+
content:
|
|
11811
|
+
application/json:
|
|
11812
|
+
schema:
|
|
11813
|
+
$ref: '#/components/schemas/MemoryFactPatchRequest'
|
|
11814
|
+
required: true
|
|
11815
|
+
responses:
|
|
11816
|
+
'200':
|
|
11817
|
+
content:
|
|
11818
|
+
application/json:
|
|
11819
|
+
schema:
|
|
11820
|
+
$ref: '#/components/schemas/MemoryFact'
|
|
11821
|
+
description: Successful Response
|
|
11822
|
+
'401':
|
|
11823
|
+
content:
|
|
11824
|
+
application/problem+json:
|
|
11825
|
+
example:
|
|
11826
|
+
code: ERROR_AUTHENTICATION
|
|
11827
|
+
detail: Additional error context.
|
|
11828
|
+
status: 401
|
|
11829
|
+
title: Authentication Error
|
|
11830
|
+
type: authentication
|
|
11831
|
+
schema:
|
|
11832
|
+
$ref: '#/components/schemas/Problem'
|
|
11833
|
+
description: Unauthorized
|
|
11834
|
+
'404':
|
|
11835
|
+
content:
|
|
11836
|
+
application/problem+json:
|
|
11837
|
+
example:
|
|
11838
|
+
code: ERROR_AI_CONCIERGE
|
|
11839
|
+
detail: AI Concierge memory resource not found
|
|
11840
|
+
status: 404
|
|
11841
|
+
title: AI Concierge memory resource not found.
|
|
11842
|
+
type: ai-concierge-memory-not-found
|
|
11843
|
+
schema:
|
|
11844
|
+
$ref: '#/components/schemas/Problem'
|
|
11845
|
+
description: Not Found
|
|
11846
|
+
'422':
|
|
11847
|
+
content:
|
|
11848
|
+
application/problem+json:
|
|
11849
|
+
schema:
|
|
11850
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
11851
|
+
description: Validation Error
|
|
11852
|
+
'502':
|
|
11853
|
+
content:
|
|
11854
|
+
application/problem+json:
|
|
11855
|
+
example:
|
|
11856
|
+
code: ERROR_AI_CONCIERGE
|
|
11857
|
+
detail: AI Concierge memory service error
|
|
11858
|
+
status: 502
|
|
11859
|
+
title: AI Concierge memory service error.
|
|
11860
|
+
type: ai-concierge-memory
|
|
11861
|
+
schema:
|
|
11862
|
+
$ref: '#/components/schemas/Problem'
|
|
11863
|
+
description: Bad Gateway
|
|
11864
|
+
security:
|
|
11865
|
+
- OAuth2PasswordBearer: []
|
|
11866
|
+
- APIKeyHeader: []
|
|
11867
|
+
summary: Update a long-term memory fact
|
|
11868
|
+
tags:
|
|
11869
|
+
- ai_concierge
|
|
11870
|
+
/v1/archive/email-forward-logs/aliases/{email_forward_alias_id}:
|
|
11871
|
+
get:
|
|
11872
|
+
description: Retrieves a paginated list of email forward logs for a specific
|
|
11873
|
+
email forward alias. Only returns logs created after the email forward was
|
|
11874
|
+
created.
|
|
11875
|
+
operationId: get_email_forward_logs_by_alias_v1_archive_email_forward_logs_aliases__email_forward_alias_id__get
|
|
11876
|
+
parameters:
|
|
11877
|
+
- in: path
|
|
11878
|
+
name: email_forward_alias_id
|
|
11879
|
+
required: true
|
|
11880
|
+
schema:
|
|
11881
|
+
examples:
|
|
11882
|
+
- email_forward_alias_01h45ytscbebyvny4gc8cr8ma2
|
|
11883
|
+
format: typeid
|
|
11884
|
+
pattern: ^email_forward_alias_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
11885
|
+
title: Email Forward Alias Id
|
|
10304
11886
|
type: string
|
|
10305
11887
|
x-typeid-prefix: email_forward_alias
|
|
10306
11888
|
- in: query
|
|
@@ -16355,16 +17937,39 @@ paths:
|
|
|
16355
17937
|
- domain
|
|
16356
17938
|
/v1/domains/check:
|
|
16357
17939
|
get:
|
|
17940
|
+
description: "Performs a real-time check against the authoritative registry\
|
|
17941
|
+
\ for each domain and returns availability plus any registry-specific metadata\
|
|
17942
|
+
\ needed to register it.\n\nFor each domain the response includes:\n- **Availability**\
|
|
17943
|
+
\ \u2014 whether the domain can be registered, and the registry's reason if\
|
|
17944
|
+
\ not.\n- **Trademark claims (TMCH)** \u2014 when the TLD is in its claims\
|
|
17945
|
+
\ phase and the domain matches a trademark in the Trademark Clearinghouse,\
|
|
17946
|
+
\ a `claims_key` is returned. The corresponding claims notice must be retrieved\
|
|
17947
|
+
\ and acknowledged before the domain can be registered. See the [Trademarked\
|
|
17948
|
+
\ domains](/products/domains/trademarked-domains) guide for the full workflow.\n\
|
|
17949
|
+
- **Premium status and pricing** \u2014 whether the domain is classified as\
|
|
17950
|
+
\ premium by the registry, and if so, the price per action (create / renew\
|
|
17951
|
+
\ / transfer / restore). See the [Premium domains](/products/domains/premium)\
|
|
17952
|
+
\ guide for background on how premium domains are priced and registered.\n\
|
|
17953
|
+
\nDomains are queried in parallel, grouped by registry connection. Availability\
|
|
17954
|
+
\ and metadata reflect the registry's state at the moment of the call and\
|
|
17955
|
+
\ are not cached."
|
|
16358
17956
|
operationId: epp_check_domain_v1_domains_check_get
|
|
16359
17957
|
parameters:
|
|
16360
17958
|
- description: '
|
|
16361
17959
|
|
|
16362
|
-
|
|
17960
|
+
One or more fully-qualified domain names to check at the registry.
|
|
17961
|
+
|
|
17962
|
+
|
|
17963
|
+
Each domain is checked for availability and, when applicable, enriched with
|
|
17964
|
+
|
|
17965
|
+
trademark claims information and premium pricing. The list of domains may
|
|
17966
|
+
|
|
17967
|
+
include a mix of TLDs.
|
|
16363
17968
|
|
|
16364
17969
|
'
|
|
16365
17970
|
examples:
|
|
16366
17971
|
list:
|
|
16367
|
-
summary: A list of
|
|
17972
|
+
summary: A list of domain names to check
|
|
16368
17973
|
value:
|
|
16369
17974
|
- example.com
|
|
16370
17975
|
- example.org
|
|
@@ -16374,7 +17979,16 @@ paths:
|
|
|
16374
17979
|
schema:
|
|
16375
17980
|
description: '
|
|
16376
17981
|
|
|
16377
|
-
|
|
17982
|
+
One or more fully-qualified domain names to check at the registry.
|
|
17983
|
+
|
|
17984
|
+
|
|
17985
|
+
Each domain is checked for availability and, when applicable, enriched
|
|
17986
|
+
with
|
|
17987
|
+
|
|
17988
|
+
trademark claims information and premium pricing. The list of domains
|
|
17989
|
+
may
|
|
17990
|
+
|
|
17991
|
+
include a mix of TLDs.
|
|
16378
17992
|
|
|
16379
17993
|
'
|
|
16380
17994
|
items:
|
|
@@ -16397,7 +18011,7 @@ paths:
|
|
|
16397
18011
|
security:
|
|
16398
18012
|
- OAuth2PasswordBearer: []
|
|
16399
18013
|
- APIKeyHeader: []
|
|
16400
|
-
summary: Check domain availability
|
|
18014
|
+
summary: Check domain availability and registration metadata
|
|
16401
18015
|
tags:
|
|
16402
18016
|
- domain
|
|
16403
18017
|
/v1/domains/summary:
|