Laravel API Documentation

Postman collection → OpenAPI spec →

Introduction

This documentation aims to provide all the information you need to work with our API.

<aside>As you scroll, you'll see code examples for working with the API in different programming languages in the dark area to the right (or as part of the content on mobile).
You can switch the language used with the tabs at the top right (or from the nav menu at the top left on mobile).</aside>

Authenticating requests

This API is not authenticated.

Endpoints

GET api/awards

GET
https://america-hyperlipemic-grazyna.ngrok-free.dev
/api/awards

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json
Example request: 
curl --request GET \
    --get "https://america-hyperlipemic-grazyna.ngrok-free.dev/api/awards" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
    "success": false,
    "message": "The route api/awards could not be found."
}

GET api/awards/{id}

GET
https://america-hyperlipemic-grazyna.ngrok-free.dev
/api/awards/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the award.

Example:
consequatur
Example request: 
curl --request GET \
    --get "https://america-hyperlipemic-grazyna.ngrok-free.dev/api/awards/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
    "success": false,
    "message": "The route api/awards/consequatur could not be found."
}

GET api/awards/{id}/scientists

GET
https://america-hyperlipemic-grazyna.ngrok-free.dev
/api/awards/{id}/scientists

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the award.

Example:
consequatur
Example request: 
curl --request GET \
    --get "https://america-hyperlipemic-grazyna.ngrok-free.dev/api/awards/consequatur/scientists" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
    "success": false,
    "message": "The route api/awards/consequatur/scientists could not be found."
}

GET api/scientists

GET
https://america-hyperlipemic-grazyna.ngrok-free.dev
/api/scientists

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json
Example request: 
curl --request GET \
    --get "https://america-hyperlipemic-grazyna.ngrok-free.dev/api/scientists" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
    "success": false,
    "message": "The route api/scientists could not be found."
}

GET api/scientists/{id}

GET
https://america-hyperlipemic-grazyna.ngrok-free.dev
/api/scientists/{id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the scientist.

Example:
consequatur
Example request: 
curl --request GET \
    --get "https://america-hyperlipemic-grazyna.ngrok-free.dev/api/scientists/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
    "success": false,
    "message": "The route api/scientists/consequatur could not be found."
}

GET api/scientists/{id}/awards

GET
https://america-hyperlipemic-grazyna.ngrok-free.dev
/api/scientists/{id}/awards

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
string
required

The ID of the scientist.

Example:
consequatur
Example request: 
curl --request GET \
    --get "https://america-hyperlipemic-grazyna.ngrok-free.dev/api/scientists/consequatur/awards" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
    "success": false,
    "message": "The route api/scientists/consequatur/awards could not be found."
}

---------------- Auth ----------------

POST
https://america-hyperlipemic-grazyna.ngrok-free.dev
/api/user/register

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request: 
curl --request POST \
    "https://america-hyperlipemic-grazyna.ngrok-free.dev/api/user/register" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"email\": \"kunde.eloisa@example.com\",
    \"password\": \"4[*UyPJ\\\"}6\"
}"

POST api/user/login

POST
https://america-hyperlipemic-grazyna.ngrok-free.dev
/api/user/login

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request: 
curl --request POST \
    "https://america-hyperlipemic-grazyna.ngrok-free.dev/api/user/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"qkunze@example.com\",
    \"password\": \"O[2UZ5ij-e\\/dl4m{o,\"
}"

---------------- Email Verification ----------------

POST
https://america-hyperlipemic-grazyna.ngrok-free.dev
/api/user/verify-email

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request: 
curl --request POST \
    "https://america-hyperlipemic-grazyna.ngrok-free.dev/api/user/verify-email" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"qkunze@example.com\",
    \"otp\": \"810798\"
}"

POST api/user/resend-otp

POST
https://america-hyperlipemic-grazyna.ngrok-free.dev
/api/user/resend-otp

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request: 
curl --request POST \
    "https://america-hyperlipemic-grazyna.ngrok-free.dev/api/user/resend-otp" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"qkunze@example.com\"
}"

---------------- Password Reset ----------------

POST
https://america-hyperlipemic-grazyna.ngrok-free.dev
/api/user/forgot-password

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request: 
curl --request POST \
    "https://america-hyperlipemic-grazyna.ngrok-free.dev/api/user/forgot-password" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"qkunze@example.com\"
}"

POST api/user/reset-password

POST
https://america-hyperlipemic-grazyna.ngrok-free.dev
/api/user/reset-password

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request: 
curl --request POST \
    "https://america-hyperlipemic-grazyna.ngrok-free.dev/api/user/reset-password" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"qkunze@example.com\",
    \"otp\": \"810798\",
    \"password\": \"[2UZ5ij-e\\/dl4\"
}"

POST api/user/resend-reset-password-otp

POST
https://america-hyperlipemic-grazyna.ngrok-free.dev
/api/user/resend-reset-password-otp

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request: 
curl --request POST \
    "https://america-hyperlipemic-grazyna.ngrok-free.dev/api/user/resend-reset-password-otp" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"qkunze@example.com\"
}"

---------------- Google OAuth ----------------

POST
https://america-hyperlipemic-grazyna.ngrok-free.dev
/api/user/auth/google

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request: 
curl --request POST \
    "https://america-hyperlipemic-grazyna.ngrok-free.dev/api/user/auth/google" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"access_token\": \"consequatur\"
}"

---------------- Profile ----------------

GET
https://america-hyperlipemic-grazyna.ngrok-free.dev
/api/user/profile

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json
Example request: 
curl --request GET \
    --get "https://america-hyperlipemic-grazyna.ngrok-free.dev/api/user/profile" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:

POST api/user/logout

POST
https://america-hyperlipemic-grazyna.ngrok-free.dev
/api/user/logout

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json
Example request: 
curl --request POST \
    "https://america-hyperlipemic-grazyna.ngrok-free.dev/api/user/logout" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

GET api/news

GET
https://america-hyperlipemic-grazyna.ngrok-free.dev
/api/news

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json
Example request: 
curl --request GET \
    --get "https://america-hyperlipemic-grazyna.ngrok-free.dev/api/news" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
    "success": false,
    "message": "The route api/news could not be found."
}

GET api/news/refresh

GET
https://america-hyperlipemic-grazyna.ngrok-free.dev
/api/news/refresh

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json
Example request: 
curl --request GET \
    --get "https://america-hyperlipemic-grazyna.ngrok-free.dev/api/news/refresh" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
    "success": false,
    "message": "The route api/news/refresh could not be found."
}

GET api/news/clear

GET
https://america-hyperlipemic-grazyna.ngrok-free.dev
/api/news/clear

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json
Example request: 
curl --request GET \
    --get "https://america-hyperlipemic-grazyna.ngrok-free.dev/api/news/clear" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
    "success": false,
    "message": "The route api/news/clear could not be found."
}

GET api/news/categories

GET
https://america-hyperlipemic-grazyna.ngrok-free.dev
/api/news/categories

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json
Example request: 
curl --request GET \
    --get "https://america-hyperlipemic-grazyna.ngrok-free.dev/api/news/categories" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
    "success": false,
    "message": "The route api/news/categories could not be found."
}

POST api/news/{articleId}/share

POST
https://america-hyperlipemic-grazyna.ngrok-free.dev
/api/news/{articleId}/share

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

articleId
string
required
Example:
consequatur
Example request: 
curl --request POST \
    "https://america-hyperlipemic-grazyna.ngrok-free.dev/api/news/consequatur/share" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

POST api/news/{articleId}/save

POST
https://america-hyperlipemic-grazyna.ngrok-free.dev
/api/news/{articleId}/save

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

articleId
string
required
Example:
consequatur
Example request: 
curl --request POST \
    "https://america-hyperlipemic-grazyna.ngrok-free.dev/api/news/consequatur/save" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

GET api/news/saved

GET
https://america-hyperlipemic-grazyna.ngrok-free.dev
/api/news/saved

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json
Example request: 
curl --request GET \
    --get "https://america-hyperlipemic-grazyna.ngrok-free.dev/api/news/saved" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
    "success": false,
    "message": "The route api/news/saved could not be found."
}

DELETE api/news/saved/{savedArticleId}

DELETE
https://america-hyperlipemic-grazyna.ngrok-free.dev
/api/news/saved/{savedArticleId}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

savedArticleId
string
required
Example:
consequatur
Example request: 
curl --request DELETE \
    "https://america-hyperlipemic-grazyna.ngrok-free.dev/api/news/saved/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

POST api/ai/run

POST
https://america-hyperlipemic-grazyna.ngrok-free.dev
/api/ai/run

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example request: 
curl --request POST \
    "https://america-hyperlipemic-grazyna.ngrok-free.dev/api/ai/run" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"num_smiles\": 17,
    \"top_k\": 17,
    \"Docking\": 11613.31890586,
    \"DeepPurpose_Affinity\": 11613.31890586,
    \"SA\": 11613.31890586,
    \"TPSA\": 11613.31890586,
    \"MW\": 11613.31890586
}"

GET api/ai/status/{job_job_id}

GET
https://america-hyperlipemic-grazyna.ngrok-free.dev
/api/ai/status/{job_job_id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

job_job_id
string
required

The ID of the job job.

Example:
consequatur
Example request: 
curl --request GET \
    --get "https://america-hyperlipemic-grazyna.ngrok-free.dev/api/ai/status/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
    "success": false,
    "message": "The route api/ai/status/consequatur could not be found."
}

GET api/ai/preview/{job_job_id}

GET
https://america-hyperlipemic-grazyna.ngrok-free.dev
/api/ai/preview/{job_job_id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

job_job_id
string
required

The ID of the job job.

Example:
consequatur
Example request: 
curl --request GET \
    --get "https://america-hyperlipemic-grazyna.ngrok-free.dev/api/ai/preview/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
    "success": false,
    "message": "The route api/ai/preview/consequatur could not be found."
}

GET api/ai/download/top/{job_job_id}

GET
https://america-hyperlipemic-grazyna.ngrok-free.dev
/api/ai/download/top/{job_job_id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

job_job_id
string
required

The ID of the job job.

Example:
consequatur
Example request: 
curl --request GET \
    --get "https://america-hyperlipemic-grazyna.ngrok-free.dev/api/ai/download/top/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
    "success": false,
    "message": "The route api/ai/download/top/consequatur could not be found."
}

GET api/ai/download/full/{job_job_id}

GET
https://america-hyperlipemic-grazyna.ngrok-free.dev
/api/ai/download/full/{job_job_id}

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

job_job_id
string
required

The ID of the job job.

Example:
consequatur
Example request: 
curl --request GET \
    --get "https://america-hyperlipemic-grazyna.ngrok-free.dev/api/ai/download/full/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
    "success": false,
    "message": "The route api/ai/download/full/consequatur could not be found."
}

GET api/ai/history

GET
https://america-hyperlipemic-grazyna.ngrok-free.dev
/api/ai/history

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json
Example request: 
curl --request GET \
    --get "https://america-hyperlipemic-grazyna.ngrok-free.dev/api/ai/history" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
Headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
{
    "success": false,
    "message": "The route api/ai/history could not be found."
}

POST api/upload-file

POST
https://america-hyperlipemic-grazyna.ngrok-free.dev
/api/upload-file

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json
Example request: 
curl --request POST \
    "https://america-hyperlipemic-grazyna.ngrok-free.dev/api/upload-file" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"