neurosynth_compose_sdk.NeurovaultApi

All URIs are relative to https://compose.neurosynth.org/api

Method	HTTP request	Description
neurovault_collections_get	GET /neurovault-collections	Get neurovault collections
neurovault_collections_id_get	GET /neurovault-collections/{id}	Your GET endpoint
neurovault_collections_id_put	PUT /neurovault-collections/{id}
neurovault_collections_post	POST /neurovault-collections	Create neurovault collection
neurovault_files_get	GET /neurovault-files	Your GET endpoint
neurovault_files_id_get	GET /neurovault-files/{id}	Your GET endpoint
neurovault_files_id_put	PUT /neurovault-files/{id}
neurovault_files_post	POST /neurovault-files

neurovault_collections_get

neurovault_collections_get()

Get neurovault collections

Example

import time
import os
import neurosynth_compose_sdk
from neurosynth_compose_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://compose.neurosynth.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = neurosynth_compose_sdk.Configuration(
    host = "https://compose.neurosynth.org/api"
)


# Enter a context with an instance of the API client
with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = neurosynth_compose_sdk.NeurovaultApi(api_client)

    try:
        # Get neurovault collections
        api_instance.neurovault_collections_get()
    except Exception as e:
        print("Exception when calling NeurovaultApi->neurovault_collections_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

neurovault_collections_id_get

NeurovaultCollectionReturn neurovault_collections_id_get(id)

Your GET endpoint

Example

import time
import os
import neurosynth_compose_sdk
from neurosynth_compose_sdk.models.neurovault_collection_return import NeurovaultCollectionReturn
from neurosynth_compose_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://compose.neurosynth.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = neurosynth_compose_sdk.Configuration(
    host = "https://compose.neurosynth.org/api"
)


# Enter a context with an instance of the API client
with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = neurosynth_compose_sdk.NeurovaultApi(api_client)
    id = 'id_example' # str | 

    try:
        # Your GET endpoint
        api_response = api_instance.neurovault_collections_id_get(id)
        print("The response of NeurovaultApi->neurovault_collections_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NeurovaultApi->neurovault_collections_id_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

NeurovaultCollectionReturn

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

neurovault_collections_id_put

NeurovaultCollectionReturn neurovault_collections_id_put(id)

Example

Bearer Authentication (JSON-Web-Token):

import time
import os
import neurosynth_compose_sdk
from neurosynth_compose_sdk.models.neurovault_collection_return import NeurovaultCollectionReturn
from neurosynth_compose_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://compose.neurosynth.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = neurosynth_compose_sdk.Configuration(
    host = "https://compose.neurosynth.org/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: JSON-Web-Token
configuration = neurosynth_compose_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = neurosynth_compose_sdk.NeurovaultApi(api_client)
    id = 'id_example' # str | 

    try:
        # 
        api_response = api_instance.neurovault_collections_id_put(id)
        print("The response of NeurovaultApi->neurovault_collections_id_put:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NeurovaultApi->neurovault_collections_id_put: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

NeurovaultCollectionReturn

Authorization

JSON-Web-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

neurovault_collections_post

neurovault_collections_post(neurovault_collection=neurovault_collection)

Create neurovault collection

Example

Bearer Authentication (JSON-Web-Token):

import time
import os
import neurosynth_compose_sdk
from neurosynth_compose_sdk.models.neurovault_collection import NeurovaultCollection
from neurosynth_compose_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://compose.neurosynth.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = neurosynth_compose_sdk.Configuration(
    host = "https://compose.neurosynth.org/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: JSON-Web-Token
configuration = neurosynth_compose_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = neurosynth_compose_sdk.NeurovaultApi(api_client)
    neurovault_collection = neurosynth_compose_sdk.NeurovaultCollection() # NeurovaultCollection |  (optional)

    try:
        # Create neurovault collection
        api_instance.neurovault_collections_post(neurovault_collection=neurovault_collection)
    except Exception as e:
        print("Exception when calling NeurovaultApi->neurovault_collections_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
neurovault_collection	NeurovaultCollection		[optional]

Return type

void (empty response body)

Authorization

JSON-Web-Token

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

neurovault_files_get

NeurovaultFileList neurovault_files_get()

Your GET endpoint

Example

import time
import os
import neurosynth_compose_sdk
from neurosynth_compose_sdk.models.neurovault_file_list import NeurovaultFileList
from neurosynth_compose_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://compose.neurosynth.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = neurosynth_compose_sdk.Configuration(
    host = "https://compose.neurosynth.org/api"
)


# Enter a context with an instance of the API client
with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = neurosynth_compose_sdk.NeurovaultApi(api_client)

    try:
        # Your GET endpoint
        api_response = api_instance.neurovault_files_get()
        print("The response of NeurovaultApi->neurovault_files_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NeurovaultApi->neurovault_files_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

NeurovaultFileList

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

neurovault_files_id_get

NeurovaultFileReturn neurovault_files_id_get(id)

Your GET endpoint

Example

import time
import os
import neurosynth_compose_sdk
from neurosynth_compose_sdk.models.neurovault_file_return import NeurovaultFileReturn
from neurosynth_compose_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://compose.neurosynth.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = neurosynth_compose_sdk.Configuration(
    host = "https://compose.neurosynth.org/api"
)


# Enter a context with an instance of the API client
with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = neurosynth_compose_sdk.NeurovaultApi(api_client)
    id = 'id_example' # str | 

    try:
        # Your GET endpoint
        api_response = api_instance.neurovault_files_id_get(id)
        print("The response of NeurovaultApi->neurovault_files_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NeurovaultApi->neurovault_files_id_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

NeurovaultFileReturn

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

neurovault_files_id_put

NeurovaultFileReturn neurovault_files_id_put(id, collection_id=collection_id, exception=exception, traceback=traceback, status=status, image_id=image_id, name=name, url=url)

Example

Bearer Authentication (JSON-Web-Token):

import time
import os
import neurosynth_compose_sdk
from neurosynth_compose_sdk.models.neurovault_file_return import NeurovaultFileReturn
from neurosynth_compose_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://compose.neurosynth.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = neurosynth_compose_sdk.Configuration(
    host = "https://compose.neurosynth.org/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: JSON-Web-Token
configuration = neurosynth_compose_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = neurosynth_compose_sdk.NeurovaultApi(api_client)
    id = 'id_example' # str | 
    collection_id = 'collection_id_example' # str |  (optional)
    exception = 'exception_example' # str |  (optional)
    traceback = 'traceback_example' # str |  (optional)
    status = 'status_example' # str |  (optional)
    image_id = 'image_id_example' # str |  (optional)
    name = 'name_example' # str |  (optional)
    url = 'url_example' # str |  (optional)

    try:
        # 
        api_response = api_instance.neurovault_files_id_put(id, collection_id=collection_id, exception=exception, traceback=traceback, status=status, image_id=image_id, name=name, url=url)
        print("The response of NeurovaultApi->neurovault_files_id_put:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NeurovaultApi->neurovault_files_id_put: %s\n" % e)

Parameters

Name	Type	Notes
id	str
collection_id	str	[optional]
exception	str	[optional]
traceback	str	[optional]
status	str	[optional]
image_id	str	[optional]
name	str	[optional]
url	str	[optional]

Return type

NeurovaultFileReturn

Authorization

JSON-Web-Token

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

neurovault_files_post

NeurovaultFileReturn neurovault_files_post(neurovault_file=neurovault_file)

Example

Bearer Authentication (JSON-Web-Token):

import time
import os
import neurosynth_compose_sdk
from neurosynth_compose_sdk.models.neurovault_file import NeurovaultFile
from neurosynth_compose_sdk.models.neurovault_file_return import NeurovaultFileReturn
from neurosynth_compose_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://compose.neurosynth.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = neurosynth_compose_sdk.Configuration(
    host = "https://compose.neurosynth.org/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: JSON-Web-Token
configuration = neurosynth_compose_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = neurosynth_compose_sdk.NeurovaultApi(api_client)
    neurovault_file = neurosynth_compose_sdk.NeurovaultFile() # NeurovaultFile |  (optional)

    try:
        # 
        api_response = api_instance.neurovault_files_post(neurovault_file=neurovault_file)
        print("The response of NeurovaultApi->neurovault_files_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NeurovaultApi->neurovault_files_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
neurovault_file	NeurovaultFile		[optional]

Return type

NeurovaultFileReturn

Authorization

JSON-Web-Token

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

NeurovaultApi.md

Latest commit

History

NeurovaultApi.md

File metadata and controls

neurosynth_compose_sdk.NeurovaultApi

neurovault_collections_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

neurovault_collections_id_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

neurovault_collections_id_put

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

neurovault_collections_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

neurovault_files_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

neurovault_files_id_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

neurovault_files_id_put

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

neurovault_files_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details