Stream Metadata

get
Get Stream Metadata

https://api.sentenai.com/streams/<stream-name>/metadata
Request
Response
Request
Path Parameters
stream-name
required
string
Metadata for this stream
Headers
Auth-Key
required
string
Your Sentenai API key
Response
200: OK
An object with all set values.
{
"foo": true,
"bar": 5.5
}

post
Create Stream with Metadata

https://api.sentenai.com/streams/<stream-name>/metadata
Define the metadata for a stream, even though it has no events yet.
Request
Response
Request
Path Parameters
stream-name
required
string
The stream being created
Headers
Auth-Key
required
string
Your Sentenai API key
Body Parameters
optional
string
Object to be used as the stream's metadata
Response
200: OK
409: Conflict
{
"code": 409,
"message": "Stream already exists."
}

patch
Modify Stream Metadata

https://api.sentenai.com/streams/<stream-name>/metadata
Including a new value for an existing metadata key will update the key
Request
Response
Request
Path Parameters
stream-name
required
string
Metadata for this stream
Headers
Content-Type
required
string
application/json
Auth-Key
required
string
Your Sentenai API key
Body Parameters
required
object
Object with new values for existing metadata keys
Response
204: No Content

put
Overwrite Stream Metadata

https://api.sentenai.com/streams/<stream-name>/metadata
Request
Response
Request
Path Parameters
stream-name
required
string
Metadata for this stream
Response
200: OK

get
Get Metadata by Key

https://api.sentenai.com/streams/<stream-name>/metadata/<key>
Request
Response
Request
Path Parameters
stream-name
required
string
Metadata for this stream
key
required
string
Metadata key
Response
200: OK
The metadata value held at `key`.
"Boston"

post
New Metadata by Key

https://api.sentenai.com/streams/<stream-name>/metadata/<key>
Request
Response
Request
Path Parameters
stream-name
required
string
Metadata for this stream
key
required
string
Metadata key
Response
201: Created

put
Set Metadata by Key

https://api.sentenai.com/streams/<stream-name>/metadata/<key>
Request
Response
Request
Path Parameters
stream-name
required
string
Metadata for this stream
key
required
string
Metadata key
Response
201: Created

delete
Delete Metadata by Key

https://api.sentenai.com/streams/<stream-name>/metadata/<key>
Request
Response
Request
Path Parameters
stream-name
required
string
Metadata for this stream
key
required
string
Metadata key
Response
204: No Content