Documents

Notes
Expert level
The API key should be sent as a Bearer token in the Authorization header of the request. Get your API key.
List

API endpoint:

GET 
https://rezexpert.ai/api/v1/documents

Request example: 

curl --location --request GET 'https://rezexpert.ai/api/v1/documents' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parameter
Type
Description
search
optional string
The search query.
search_by
optional string
Search by. Possible values are: name for Name, result for Result. Defaults to: name.
template_id
optional integer
Filter by template ID. Possible values are: about-us for About us, advertisement for Advertisement, article for Article, blog-intro for Blog intro, blog-outlines for Blog outlines, blog-outro for Blog outro, blog-paragraph for Blog paragraph, blog-post for Blog post, blog-section for Blog section, blog-talking-points for Blog talking points, blog-title for Blog title, business-description for Business Description, call-to-action for Call to action, cancellation-policy for Cancellation Policy, content-rewrite for Content rewrite, content-summary for Content summary, deposit-policy for Deposit Policy, email-promo for Email Promotion, facebook-ad for Facebook Advertisement, faq for Frequently Asked Questions, freestyle for Freestyle, hashtags for Hashtags, headline for Headline, linkedin-ad for LinkedIn Advertisement, meta-description for Meta description, mission-statement for Mission statement, newsletter for Newsletter, package-promo for Seasonal Packages and Promotions, paragraph for Paragraph, press-release for Press release, subheadline for Subheadline, terms-conditions for Terms and Conditions, testimonial for Testimonial, tweet for Tweet, twitter-thread for Twitter thread, unit-description for Unit Description, value-proposition for Value proposition, video-description for Video description, video-tags for Video tags, video-title for Video title, vision-statement for Vision statement. Defaults to: freestyle.
favorite
optional boolean
Filter by favorite.
sort_by
optional string
Sort by. Possible values are: id for Date created, name for Name. Defaults to: id.
sort
optional string
Sort. Possible values are: desc for Descending, asc for Ascending. Defaults to: desc.
per_page
optional int
Results per page. Possible values are: 10, 25, 50, 100. Defaults to: 10.
Show

API endpoint:

GET 
https://rezexpert.ai/api/v1/documents/{id}

Request example: 

curl --location --request GET 'https://rezexpert.ai/api/v1/documents/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Store

API endpoint:

POST 
https://rezexpert.ai/api/v1/documents

Request example: 

curl --location --request POST 'https://rezexpert.ai/api/v1/documents' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}' \
--data-urlencode 'prompt={prompt}'
Parameter
Type
Description
name
required string
The template name.
prompt
required string
The instructions for the AI.
creativity
required float
The creative level of the result. Possible values are: 0 for Repetitive, 0.25 for Deterministic, 0.5 for Original, 0.75 for Creative, 1 for Imaginative. Defaults to: 0.5.
Update

API endpoint:

PUT PATCH 
https://rezexpert.ai/api/v1/documents/{id}

Request example: 

curl --location --request PUT 'https://rezexpert.ai/api/v1/documents/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parameter
Type
Description
name
optional string
The template name.
result
optional string
The document result.
favorite
optional boolean
Whether the document is favorite or not.
Delete

API endpoint:

DELETE 
https://rezexpert.ai/api/v1/documents/{id}

Request example: 

curl --location --request DELETE 'https://rezexpert.ai/api/v1/documents/{id}' \
--header 'Authorization: Bearer {api_key}'